Fork me on GitHub

subsample: Subsample tableΒΆ

Docstring:

Usage: qiime feature-table subsample [OPTIONS]

  Randomly pick samples or features, without replacement, from the table.

Options:
  --i-table ARTIFACT PATH FeatureTable[Frequency]
                                  The feature table to be sampled.  [required]
  --p-subsampling-depth INTEGER RANGE
                                  The total number of samples or features to
                                  be randomly sampled. Samples or features
                                  that are reduced to a zero sum will not be
                                  included in the resulting table.  [required]
  --p-axis [feature|sample]       The axis to sample over. If "sample" then
                                  samples will be randomly selected to be
                                  retained. If "feature" then a random set of
                                  features will be selected to be retained.
                                  [required]
  --o-sampled-table ARTIFACT PATH FeatureTable[Frequency]
                                  The resulting subsampled feature table.
                                  [required if not passing --output-dir]
  --output-dir DIRECTORY          Output unspecified results to a directory
  --cmd-config FILE               Use config file for command options
  --verbose                       Display verbose output to stdout and/or
                                  stderr during execution of this action.
                                  [default: False]
  --quiet                         Silence output if execution is successful
                                  (silence is golden).  [default: False]
  --citations                     Show citations and exit.
  --help                          Show this message and exit.

Import:

from qiime2.plugins.feature_table.methods import subsample

Docstring:

Subsample table

Randomly pick samples or features, without replacement, from the table.

Parameters
----------
table : FeatureTable[Frequency]
    The feature table to be sampled.
subsampling_depth : Int % Range(1, None)
    The total number of samples or features to be randomly sampled. Samples
    or features that are reduced to a zero sum will not be included in the
    resulting table.
axis : Str % Choices({'feature', 'sample'})
    The axis to sample over. If "sample" then samples will be randomly
    selected to be retained. If "feature" then a random set of features
    will be selected to be retained.

Returns
-------
sampled_table : FeatureTable[Frequency]
    The resulting subsampled feature table.