Fork me on GitHub

alpha-group-significance: Alpha diversity comparisons

Citations

[diversity:alpha-group-significance:KW52]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.

Docstring:

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

  Visually and statistically compare groups of alpha diversity values.

Options:
  --i-alpha-diversity ARTIFACT PATH SampleData[AlphaDiversity]
                                  Vector of alpha diversity values by sample.
                                  [required]
  --m-metadata-file MULTIPLE FILE
                                  Metadata file or artifact viewable as
                                  metadata. This option may be supplied
                                  multiple times to merge metadata. The sample
                                  metadata.  [required]
  --o-visualization VISUALIZATION PATH
                                  [required if not passing --output-dir]
  --output-dir DIRECTORY          Output unspecified results to a directory
  --cmd-config FILE               Use config file for command options
  --verbose                       Display verbose output to stdout and/or
                                  stderr during execution of this action.
                                  [default: False]
  --quiet                         Silence output if execution is successful
                                  (silence is golden).  [default: False]
  --citations                     Show citations and exit.
  --help                          Show this message and exit.

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