Fork me on GitHub

collate-feature-data-mags: Collate MAGsΒΆ

Docstring:

Usage: qiime types collate-feature-data-mags [OPTIONS]

  Takes a collection of FeatureData[MAG]'s and collates them into a single
  artifact.

Inputs:
  --i-mags ARTIFACTS... List[FeatureData[MAG]]
                         A collection of MAGs to be collated.       [required]
Outputs:
  --o-collated-mags ARTIFACT
    FeatureData[MAG]                                                [required]
Miscellaneous:
  --output-dir PATH      Output unspecified results to a directory
  --verbose / --quiet    Display verbose output to stdout and/or stderr
                         during execution of this action. Or silence output if
                         execution is successful (silence is golden).
  --example-data PATH    Write example data and exit.
  --citations            Show citations and exit.
  --use-cache DIRECTORY  Specify the cache to be used for the intermediate
                         work of this action. If not provided, the default
                         cache under $TMP/qiime2/ will be used.
                         IMPORTANT FOR HPC USERS: If you are on an HPC system
                         and are using parallel execution it is important to
                         set this to a location that is globally accessible to
                         all nodes in the cluster.
  --help                 Show this message and exit.

Import:

from qiime2.plugins.types.methods import collate_feature_data_mags

Docstring:

Collate MAGs

Takes a collection of FeatureData[MAG]'s and collates them into a single
artifact.

Parameters
----------
mags : List[FeatureData[MAG]]
    A collection of MAGs to be collated.

Returns
-------
collated_mags : FeatureData[MAG]