Fork me on GitHub

subsample-ids: Subsample tableΒΆ

Docstring:

Usage: qiime feature-table subsample-ids [OPTIONS]

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

Inputs:
  --i-table ARTIFACT FeatureTable[Frequency]
                         The feature table to be sampled.           [required]
Parameters:
  --p-subsampling-depth INTEGER
    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.                           [required]
  --p-axis TEXT Choices('sample', 'feature')
                         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]
Outputs:
  --o-sampled-table ARTIFACT FeatureTable[Frequency]
                         The resulting subsampled 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.
  --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.

Import:

from qiime2.plugins.feature_table.methods import subsample_ids

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('sample', 'feature')
    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.