Fork me on GitHub

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 VALUE Int % Range(1, None) | Str % Choices('auto')
                          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).
  --examples              Show usage examples and exit.
  --citations             Show citations and exit.
  --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 : Int % Range(1, None) | Str % Choices('auto'), optional
    The number of threads used for computation.

Returns
-------
visualization : Visualization