Warning
This site has been replaced by the new QIIME 2 “amplicon distribution” documentation, as of the 2025.4 release of QIIME 2. You can still access the content from the “old docs” here for the QIIME 2 2024.10 and earlier releases, but we recommend that you transition to the new documentation at https://amplicon-docs.qiime2.org. Content on this site is no longer updated and may be out of date.
Are you looking for:
the QIIME 2 homepage? That’s https://qiime2.org.
learning resources for microbiome marker gene (i.e., amplicon) analysis? See the QIIME 2 amplicon distribution documentation.
learning resources for microbiome metagenome analysis? See the MOSHPIT documentation.
installation instructions, plugins, books, videos, workshops, or resources? See the QIIME 2 Library.
general help? See the QIIME 2 Forum.
Old content beyond this point… 👴👵
pielou-evenness: Pielou’s Evenness¶
| Citations |
|
|---|
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).
--example-data PATH Write example data and exit.
--citations Show citations and exit.
--use-cache DIRECTORY Specify the cache to be used for the intermediate
work of this action. If not provided, the default
cache under $TMP/qiime2/ will be used.
IMPORTANT FOR HPC USERS: If you are on an HPC system
and are using parallel execution it is important to
set this to a location that is globally accessible to
all nodes in the cluster.
--help Show this message and exit.
Examples:
# ### example: basic
qiime diversity-lib pielou-evenness \
--i-table feature-table.qza \
--o-vector pielou-vector.qza
# ### example: dropping undefined samples
qiime diversity-lib pielou-evenness \
--i-table feature-table.qza \
--p-drop-undefined-samples \
--o-vector pielou-vector.qza
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.