Fork me on GitHub

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

Docstring:

Usage: qiime demux subsample-paired [OPTIONS]

  Generate a random subsample of paired-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.

Inputs:
  --i-sequences ARTIFACT SampleData[PairedEndSequencesWithQuality]
                          The demultiplexed sequences to be subsampled.
                                                                    [required]
Parameters:
  --p-fraction PROPORTION Range(0, 1, inclusive_start=False)
                          The fraction of sequences to retain in subsample.
                                                                    [required]
Outputs:
  --o-subsampled-sequences ARTIFACT
    SampleData[PairedEndSequencesWithQuality]
                          The subsampled sequences.                 [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.demux.methods import subsample_paired

Docstring:

Subsample paired-end sequences without replacement.

Generate a random subsample of paired-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]
    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[PairedEndSequencesWithQuality]
    The subsampled sequences.