Docstring:
Usage: qiime diversity alpha [OPTIONS]
Computes a user-specified alpha diversity metric for all samples in a
feature table.
Inputs:
--i-table ARTIFACT FeatureTable[Frequency | RelativeFrequency |
PresenceAbsence] The feature table containing the samples for which
alpha diversity should be computed. [required]
Parameters:
--p-metric TEXT Choices('ace', 'berger_parker_d', 'brillouin_d', 'chao1',
'chao1_ci', 'dominance', 'doubles', 'enspie', 'esty_ci', 'fisher_alpha',
'gini_index', 'goods_coverage', 'heip_e', 'kempton_taylor_q',
'lladser_pe', 'margalef', 'mcintosh_d', 'mcintosh_e', 'menhinick',
'michaelis_menten_fit', 'observed_features', 'osd', 'pielou_e', 'robbins',
'shannon', 'simpson', 'simpson_e', 'singles', 'strong')
The alpha diversity metric to be computed. Information
about specific metrics is available at
https://data.qiime2.org/a_diversity_metrics [required]
Outputs:
--o-alpha-diversity ARTIFACT SampleData[AlphaDiversity]
Vector containing per-sample alpha diversities.
[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.
Import:
from qiime2.plugins.diversity.pipelines import alpha
Docstring:
Alpha diversity
Computes a user-specified alpha diversity metric for all samples in a
feature table.
Parameters
----------
table : FeatureTable[Frequency | RelativeFrequency | PresenceAbsence]
The feature table containing the samples for which alpha diversity
should be computed.
metric : Str % Choices('ace', 'berger_parker_d', 'brillouin_d', 'chao1', 'chao1_ci', 'dominance', 'doubles', 'enspie', 'esty_ci', 'fisher_alpha', 'gini_index', 'goods_coverage', 'heip_e', 'kempton_taylor_q', 'lladser_pe', 'margalef', 'mcintosh_d', 'mcintosh_e', 'menhinick', 'michaelis_menten_fit', 'observed_features', 'osd', 'pielou_e', 'robbins', 'shannon', 'simpson', 'simpson_e', 'singles', 'strong')
The alpha diversity metric to be computed. Information about specific
metrics is available at https://data.qiime2.org/a_diversity_metrics
Returns
-------
alpha_diversity : SampleData[AlphaDiversity]
Vector containing per-sample alpha diversities.
