API Reference

This page contains auto-generated API reference documentation [1].

For generating new models, see cvanmf.denovo. To reapply a model, use cvanmf.reapply. Some existing models (currently just the five Enterosignature model) as provided by cvanmf.models. Example datasets, both synthetic and read data, are provided in data.

Experimental Modules

cvanmf.combine is an experimental module for combining models learnt from multiple cohorts to a single non-redundant pool of signatures. It is less well documented that other modules. Some of the elements will eventually be moved into cvanmf.stability to characterise how stable signatures are between multiple decompositions with the same parameters, but this module is currently incomplete, and so not linked above as part of the main documentation