Fork me on GitHub

add-pseudocount: Add pseudocount to table.ΒΆ

Docstring:

Usage: qiime composition add-pseudocount [OPTIONS]

  Increment all counts in table by pseudocount.

Inputs:
  --i-table ARTIFACT FeatureTable[Frequency]
                       The feature table to which pseudocounts should be
                       added.                                       [required]
Parameters:
  --p-pseudocount INTEGER
                       The value to add to all counts in the feature table.
                                                                  [default: 1]
Outputs:
  --o-composition-table ARTIFACT FeatureTable[Composition]
                       The resulting 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).
  --example-data PATH  Write example data and exit.
  --citations          Show citations and exit.
  --help               Show this message and exit.

Import:

from qiime2.plugins.composition.methods import add_pseudocount

Docstring:

Add pseudocount to table.

Increment all counts in table by pseudocount.

Parameters
----------
table : FeatureTable[Frequency]
    The feature table to which pseudocounts should be added.
pseudocount : Int, optional
    The value to add to all counts in the feature table.

Returns
-------
composition_table : FeatureTable[Composition]
    The resulting feature table.