Warning
This site has been replaced by the new QIIME 2 “amplicon distribution” documentation, as of the 2025.4 release of QIIME 2. You can still access the content from the “old docs” here for the QIIME 2 2024.10 and earlier releases, but we recommend that you transition to the new documentation at https://amplicon-docs.qiime2.org. Content on this site is no longer updated and may be out of date.
Are you looking for:
the QIIME 2 homepage? That’s https://qiime2.org.
learning resources for microbiome marker gene (i.e., amplicon) analysis? See the QIIME 2 amplicon distribution documentation.
learning resources for microbiome metagenome analysis? See the MOSHPIT documentation.
installation instructions, plugins, books, videos, workshops, or resources? See the QIIME 2 Library.
general help? See the QIIME 2 Forum.
Old content beyond this point… 👴👵
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.
Inputs:
--i-sequences ARTIFACT SampleData[SequencesWithQuality |
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[SequencesWithQuality]
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_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[SequencesWithQuality | 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[SequencesWithQuality]
The subsampled sequences.