Fork me on GitHub

mann-whitney-u-facet: Per-facet Mann-Whitney U Test

Citations

Docstring:

Usage: qiime stats mann-whitney-u-facet [OPTIONS]

Inputs:
  --i-distribution ARTIFACT Dist1D[Multi, Independent]¹ |
    Dist1D[NestedOrdered | NestedUnordered, Matched]² | Dist1D[NestedOrdered |
    NestedUnordered, Independent]³
                                                                    [required]
Parameters:
  --p-facet VALUE Str % Choices('within')¹'² | Str % Choices('within',
    'across')³            Whether to facet within or across the outer group.
                                                           [default: 'within']
Outputs:
  --o-stats ARTIFACT
    StatsTable[Pairwise]                                            [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).
  --recycle-pool TEXT     Use a cache pool for pipeline resumption. QIIME 2
                          will cache your results in this pool for reuse by
                          future invocations. These pool are retained until
                          deleted by the user. If not provided, QIIME 2 will
                          create a pool which is automatically reused by
                          invocations of the same action and removed if the
                          action is successful. Note: these pools are local to
                          the cache you are using.
  --no-recycle            Do not recycle results from a previous failed
                          pipeline run or save the results from this run for
                          future recycling.
  --parallel              Execute your action in parallel. This flag will use
                          your default parallel config.
  --parallel-config FILE  Execute your action in parallel using a config at
                          the indicated path.
  --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.

Examples:
  # ### example: mann whitney u facet across
  qiime stats mann-whitney-u-facet \
    --i-distribution dist.qza \
    --p-facet across \
    --o-stats stats.qza

  # ### example: mann whitney u facet within
  qiime stats mann-whitney-u-facet \
    --i-distribution dist.qza \
    --p-facet within \
    --o-stats stats.qza

Import:

from qiime2.plugins.stats.pipelines import mann_whitney_u_facet

Docstring:

Per-facet Mann-Whitney U Test



Parameters
----------
distribution : Dist1D[Multi, Independent]¹ | Dist1D[NestedOrdered | NestedUnordered, Matched]² | Dist1D[NestedOrdered | NestedUnordered, Independent]³
facet : Str % Choices('within')¹'² | Str % Choices('within', 'across')³, optional
    Whether to facet within or across the outer group.

Returns
-------
stats : StatsTable[Pairwise]