Fork me on GitHub

alpha-group-significance: Alpha diversity comparisons

Citations
  • William H Kruskal and W Allen Wallis. Use of ranks in one-criterion variance analysis. Journal of the American statistical Association, 47(260):583–621, 1952. doi:10.1080/01621459.1952.10483441.

Docstring:

Usage: qiime diversity alpha-group-significance [OPTIONS]

  Visually and statistically compare groups of alpha diversity values.

Inputs:
  --i-alpha-diversity ARTIFACT SampleData[AlphaDiversity]
                       Vector of alpha diversity values by sample.  [required]
Parameters:
  --m-metadata-file METADATA...
    (multiple          The sample metadata.
     arguments will
     be merged)                                                     [required]
Outputs:
  --o-visualization VISUALIZATION
                                                                    [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.
  --help               Show this message and exit.

Examples:
  # ### example: alpha group significance faith pd
  qiime diversity alpha-group-significance \
    --i-alpha-diversity alpha-div-faith-pd.qza \
    --m-metadata-file metadata.tsv \
    --o-visualization visualization.qzv

Import:

from qiime2.plugins.diversity.visualizers import alpha_group_significance

Docstring:

Alpha diversity comparisons

Visually and statistically compare groups of alpha diversity values.

Parameters
----------
alpha_diversity : SampleData[AlphaDiversity]
    Vector of alpha diversity values by sample.
metadata : Metadata
    The sample metadata.

Returns
-------
visualization : Visualization