Fork me on GitHub

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:

Old content beyond this point… 👴👵

fastq-stats: Fastq stats with vsearch.

Docstring:

Usage: qiime vsearch fastq-stats [OPTIONS]

  A fastq overview via vsearch's fastq_stats, fastq_eestats and fastq_eestats2
  utilities. Please see https://github.com/torognes/vsearch for detailed
  documentation of these tools.

Inputs:
  --i-sequences ARTIFACT SampleData[SequencesWithQuality |
    PairedEndSequencesWithQuality]
                          Fastq sequences                           [required]
Parameters:
  --p-threads NTHREADS    The number of threads used for computation.
                                                                  [default: 1]
Outputs:
  --o-visualization VISUALIZATION
                                                                    [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.vsearch.visualizers import fastq_stats

Docstring:

Fastq stats with vsearch.

A fastq overview via vsearch's fastq_stats, fastq_eestats and
fastq_eestats2 utilities. Please see https://github.com/torognes/vsearch
for detailed documentation of these tools.

Parameters
----------
sequences : SampleData[SequencesWithQuality | PairedEndSequencesWithQuality]
    Fastq sequences
threads : Threads, optional
    The number of threads used for computation.

Returns
-------
visualization : Visualization