Fork me on GitHub

relative-frequency: Convert to relative frequenciesΒΆ

Docstring:

Usage: qiime feature-table relative-frequency [OPTIONS]

  Convert frequencies to relative frequencies by dividing each frequency in
  a sample by the sum of frequencies in that sample.

Inputs:
  --i-table ARTIFACT FeatureTable[Frequency]
                       The feature table to be converted into relative
                       frequencies.                                 [required]
Outputs:
  --o-relative-frequency-table ARTIFACT FeatureTable[RelativeFrequency]
                       The resulting relative frequency feature table.
                                                                    [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).
  --citations          Show citations and exit.
  --help               Show this message and exit.

Import:

from qiime2.plugins.feature_table.methods import relative_frequency

Docstring:

Convert to relative frequencies

Convert frequencies to relative frequencies by dividing each frequency in a
sample by the sum of frequencies in that sample.

Parameters
----------
table : FeatureTable[Frequency]
    The feature table to be converted into relative frequencies.

Returns
-------
relative_frequency_table : FeatureTable[RelativeFrequency]
    The resulting relative frequency feature table.