Fork me on GitHub

decontam-score-viz: Generate a histogram representation of the scoresΒΆ

Docstring:

Usage: qiime quality-control decontam-score-viz [OPTIONS]

  Creates histogram based on the output of decontam identify

Inputs:
  --i-decontam-scores ARTIFACT FeatureData[DecontamScore]
                        Output from decontam identify to be visualized
                                                                    [required]
  --i-table ARTIFACT FeatureTable[Frequency]
                        Raw OTU/ASV table that was used as input to
                        decontam-identify                           [required]
Parameters:
  --p-threshold NUMBER  Select threshold cutoff for decontam algorithm scores
                                                                [default: 0.1]
  --p-weighted / --p-no-weighted
                        weight the decontam scores by their associated read
                        number                                 [default: True]
  --p-bin-size NUMBER   Select bin size for the histogram      [default: 0.02]
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.
  --help                Show this message and exit.

Import:

from qiime2.plugins.quality_control.visualizers import decontam_score_viz

Docstring:

Generate a histogram representation of the scores

Creates histogram based on the output of decontam identify

Parameters
----------
decontam_scores : FeatureData[DecontamScore]
    Output from decontam identify to be visualized
table : FeatureTable[Frequency]
    Raw OTU/ASV table that was used as input to decontam-identify
threshold : Float, optional
    Select threshold cutoff for decontam algorithm scores
weighted : Bool, optional
    weight the decontam scores by their associated read number
bin_size : Float, optional
    Select bin size for the histogram

Returns
-------
visualization : Visualization