Fork me on GitHub

Warning

This site has been replaced by the new QIIME 2 “amplicon distribution” documentation, as of the 2025.4 release of QIIME 2. You can still access the content from the “old docs” here for the QIIME 2 2024.10 and earlier releases, but we recommend that you transition to the new documentation at https://amplicon-docs.qiime2.org. Content on this site is no longer updated and may be out of date.

Are you looking for:

Old content beyond this point… 👴👵

collate-sample-data-mags: Collate MAGs

Docstring:

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

  Takes a collection of SampleData[MAGs]'s and collates them into a single
  artifact.

Inputs:
  --i-mags ARTIFACTS... List[SampleData[MAGs]]
                         A collection of MAGs to be collated.       [required]
Outputs:
  --o-collated-mags ARTIFACT
    SampleData[MAGs]                                                [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_sample_data_mags

Docstring:

Collate MAGs

Takes a collection of SampleData[MAGs]'s and collates them into a single
artifact.

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

Returns
-------
collated_mags : SampleData[MAGs]