Fork me on GitHub

pielou-evenness: Pielou’s Evenness

Citations
  • Evelyn C Pielou. The measurement of diversity in different types of biological collections. Journal of theoretical biology, 13:131–144, 1966. doi:10.1016/0022-5193(66)90013-0.

Docstring:

Usage: qiime diversity-lib pielou-evenness [OPTIONS]

  Compute Pielou's Evenness for each sample in a feature table

Inputs:
  --i-table ARTIFACT FeatureTable[Frequency | RelativeFrequency]
                       The feature table containing the samples for which
                       Pielou's evenness should be computed.        [required]
Parameters:
  --p-drop-undefined-samples / --p-no-drop-undefined-samples
                       Samples with fewer than two observed features produce
                       undefined (NaN) values. If true, these samples are
                       dropped from the output vector.        [default: False]
Outputs:
  --o-vector ARTIFACT SampleData[AlphaDiversity]
                       Vector containing per-sample values for Pielou's
                       Evenness.                                    [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).
  --examples           Show usage examples and exit.
  --citations          Show citations and exit.
  --help               Show this message and exit.

Import:

from qiime2.plugins.diversity_lib.methods import pielou_evenness

Docstring:

Pielou's Evenness

Compute Pielou's Evenness for each sample in a feature table

Parameters
----------
table : FeatureTable[Frequency | RelativeFrequency]
    The feature table containing the samples for which Pielou's evenness
    should be computed.
drop_undefined_samples : Bool, optional
    Samples with fewer than two observed features produce undefined (NaN)
    values. If true, these samples are dropped from the output vector.

Returns
-------
vector : SampleData[AlphaDiversity]
    Vector containing per-sample values for Pielou's Evenness.