Fork me on GitHub

shannon-entropy: Shannon’s Entropy

Citations

Docstring:

Usage: qiime diversity-lib shannon-entropy [OPTIONS]

  Compute Shannon's Entropy for each sample in a feature table

Inputs:
  --i-table ARTIFACT FeatureTable[Frequency | RelativeFrequency]
                       The feature table containing the samples for which
                       Shannon's Entropy should be computed.        [required]
Parameters:
  --p-drop-undefined-samples / --p-no-drop-undefined-samples
                       Samples with no 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 Shannon's
                       Entropy.                                     [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 shannon_entropy

Docstring:

Shannon's Entropy

Compute Shannon's Entropy for each sample in a feature table

Parameters
----------
table : FeatureTable[Frequency | RelativeFrequency]
    The feature table containing the samples for which Shannon's Entropy
    should be computed.
drop_undefined_samples : Bool, optional
    Samples with no 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 Shannon's Entropy.