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:
the QIIME 2 homepage? That’s https://qiime2.org.
learning resources for microbiome marker gene (i.e., amplicon) analysis? See the QIIME 2 amplicon distribution documentation.
learning resources for microbiome metagenome analysis? See the MOSHPIT documentation.
installation instructions, plugins, books, videos, workshops, or resources? See the QIIME 2 Library.
general help? See the QIIME 2 Forum.
Old content beyond this point… 👴👵
facet-across: Facet across outer group¶
Docstring:
Usage: qiime stats facet-across [OPTIONS]
Facet a distribution into per-class/level distributions where each facet
preserves the outer group structure.
Inputs:
--i-distribution ARTIFACT Dist1D[NestedOrdered¹ | NestedUnordered²,
Independent¹ | Matched²]
A nested Dist1D which will be partitioned into
non-nested Dist1D [required]
Outputs:
--o-distributions ARTIFACTS... Collection[Dist1D[Ordered¹ | Unordered²,
Independent¹ | Matched²]]
A collection of non-nested Dist1Ds [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.stats.methods import facet_across
Docstring:
Facet across outer group
Facet a distribution into per-class/level distributions where each facet
preserves the outer group structure.
Parameters
----------
distribution : Dist1D[NestedOrdered¹ | NestedUnordered², Independent¹ | Matched²]
A nested Dist1D which will be partitioned into non-nested Dist1D
Returns
-------
distributions : Collection[Dist1D[Ordered¹ | Unordered², Independent¹ | Matched²]]
A collection of non-nested Dist1Ds