Fork me on GitHub

subsample-single: Subsample single-end sequences without replacement.ΒΆ

Docstring:

Usage: qiime demux subsample-single [OPTIONS]

  Generate a random subsample of single-end sequences containing
  approximately the fraction of input sequences specified by the fraction
  parameter. The number of output samples will always be equal to the number
  of input samples, even if some of those samples contain no sequences after
  subsampling.

Options:
  --i-sequences ARTIFACT PATH SampleData[PairedEndSequencesWithQuality | SequencesWithQuality]
                                  The demultiplexed sequences to be
                                  subsampled.  [required]
  --p-fraction FLOAT              The fraction of sequences to retain in
                                  subsample.  [required]
  --o-subsampled-sequences ARTIFACT PATH SampleData[SequencesWithQuality]
                                  The subsampled sequences.  [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.demux.methods import subsample_single

Docstring:

Subsample single-end sequences without replacement.

Generate a random subsample of single-end sequences containing
approximately the fraction of input sequences specified by the fraction
parameter. The number of output samples will always be equal to the number
of input samples, even if some of those samples contain no sequences after
subsampling.

Parameters
----------
sequences : SampleData[PairedEndSequencesWithQuality | SequencesWithQuality]
    The demultiplexed sequences to be subsampled.
fraction : Float % Range(0, 1, inclusive_start=False)
    The fraction of sequences to retain in subsample.

Returns
-------
subsampled_sequences : SampleData[SequencesWithQuality]
    The subsampled sequences.