Fork me on GitHub

facet-within: Facet within outer groupΒΆ

Docstring:

Usage: qiime stats facet-within [OPTIONS]

  Facets a distribution into independent distributions where each facet is an
  inner slice from the outer group.

Inputs:
  --i-distribution ARTIFACT Dist1D[Multi | NestedOrdered | NestedUnordered,
    Matched | Independent]
                         A nested or multi Dist1D which will be partitioned
                         into undordered and independent subgroups. [required]
Outputs:
  --o-distributions ARTIFACTS... Collection[Dist1D[Unordered, Independent]]
                         A collection of unordered and independent 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_within

Docstring:

Facet within outer group

Facets a distribution into independent distributions where each facet is an
inner slice from the outer group.

Parameters
----------
distribution : Dist1D[Multi | NestedOrdered | NestedUnordered, Matched | Independent]
    A nested or multi Dist1D which will be partitioned into undordered and
    independent subgroups.

Returns
-------
distributions : Collection[Dist1D[Unordered, Independent]]
    A collection of unordered and independent Dist1Ds.