Fork me on GitHub

observed-features: Observed Features

Docstring:

Usage: qiime diversity-lib observed-features [OPTIONS]

  Compute the number of observed features for each sample in a feature table

Inputs:
  --i-table ARTIFACT FeatureTable[Frequency | RelativeFrequency |
    PresenceAbsence]     The feature table containing the samples for which
                         the number of observed features should be calculated.
                         Table values will be converted to presence/absence.
                                                                    [required]
Outputs:
  --o-vector ARTIFACT SampleData[AlphaDiversity]
                         Vector containing per-sample counts of observed
                         features.                                  [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 observed-features \
    --i-table feature-table.qza \
    --o-vector obs-feat-vector.qza

Import:

from qiime2.plugins.diversity_lib.methods import observed_features

Docstring:

Observed Features

Compute the number of observed features for each sample in a feature table

Parameters
----------
table : FeatureTable[Frequency | RelativeFrequency | PresenceAbsence]
    The feature table containing the samples for which the number of
    observed features should be calculated. Table values will be converted
    to presence/absence.

Returns
-------
vector : SampleData[AlphaDiversity]
    Vector containing per-sample counts of observed features.