annotate qiime2/qiime_quality-control_evaluate-composition.xml @ 6:de4c22a52df4 draft

Fixes
author florianbegusch
date Tue, 13 Aug 2019 07:46:48 -0400
parents a025a4a89e07
children f190567fe3f6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_quality-control_evaluate-composition" name="qiime quality-control evaluate-composition" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Evaluate expected vs. observed taxonomic composition of samples</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
8 qiime quality-control evaluate-composition
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-expected-features=$iexpectedfeatures
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-observed-features=$iobservedfeatures
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
13
5
a025a4a89e07 Uploaded
florianbegusch
parents: 2
diff changeset
14 #if $metadatafile:
a025a4a89e07 Uploaded
florianbegusch
parents: 2
diff changeset
15 --m-metadata-file=$metadatafile
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18
5
a025a4a89e07 Uploaded
florianbegusch
parents: 2
diff changeset
19 #if str($pdepth):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 --p-depth=$pdepth
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #if str($ppalette) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 --p-palette=$ppalette
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #if $pplottar:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 --p-plot-tar
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #if $pplottdr:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 --p-plot-tdr
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 #if $pplotrvalue:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 --p-plot-r-value
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 #if $pnoplotrsquared:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 --p-no-plot-r-squared
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 #if $pplotbraycurtis:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 --p-plot-bray-curtis
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 #if $pplotjaccard:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 --p-plot-jaccard
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 #if $pplotobservedfeatures:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 --p-plot-observed-features
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54
5
a025a4a89e07 Uploaded
florianbegusch
parents: 2
diff changeset
55 #if $pnoplotobservedfeaturesratio:
a025a4a89e07 Uploaded
florianbegusch
parents: 2
diff changeset
56 --p-no-plot-observed-features-ratio
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 #if str($mmetadatacolumn):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 --m-metadata-column="$mmetadatacolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <param format="qza,no_unzip.zip" label="--i-expected-features: ARTIFACT FeatureTable[RelativeFrequency] Expected feature compositions [required]" name="iexpectedfeatures" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <param format="qza,no_unzip.zip" label="--i-observed-features: ARTIFACT FeatureTable[RelativeFrequency] Observed feature compositions [required]" name="iobservedfeatures" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <param label="--p-depth: INTEGER Maximum depth of semicolon-delimited taxonomic ranks to test (e.g., 1 = root, 7 = species for the greengenes reference sequence database). [default: 7]" name="pdepth" optional="True" type="integer" value="7"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <param label="--p-palette: " name="ppalette" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <option value="Set1">Set1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <option value="Set2">Set2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <option value="Set3">Set3</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <option value="Pastel1">Pastel1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <option value="Pastel2">Pastel2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <option value="Paired">Paired</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 <option value="Accent">Accent</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <option value="Dark2">Dark2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <option value="tab10">tab10</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <option value="tab20">tab20</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 <option value="tab20b">tab20b</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 <option value="tab20c">tab20c</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 <option value="viridis">viridis</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <option value="plasma">plasma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <option value="inferno">inferno</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 <option value="magma">magma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 <option value="terrain">terrain</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 <option value="rainbow">rainbow</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 <param label="--p-plot-tar: --p-no-plot-tar Plot taxon accuracy rate (TAR) on score plot. TAR is the number of true positive features divided by the total number of observed features (TAR = true positives " name="pplottar" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 <param label="--p-plot-tdr: --p-no-plot-tdr Plot taxon detection rate (TDR) on score plot. TDR is the number of true positive features divided by the total number of expected features (TDR = true positives " name="pplottdr" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 <param label="--p-plot-r-value: --p-no-plot-r-value Plot expected vs. observed linear regression r value on score plot. [default: False]" name="pplotrvalue" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 <param label="--p-no-plot-r-squared: Do not plot expected vs. observed linear regression r-squared value on score plot. [default: False]" name="pnoplotrsquared" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 <param label="--p-plot-bray-curtis: --p-no-plot-bray-curtis Plot expected vs. observed Bray-Curtis dissimilarity scores on score plot. [default: False]" name="pplotbraycurtis" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <param label="--p-plot-jaccard: --p-no-plot-jaccard Plot expected vs. observed Jaccard distances scores on score plot. [default: False]" name="pplotjaccard" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <param label="--p-plot-observed-features: --p-no-plot-observed-features Plot observed features count on score plot. [default: False]" name="pplotobservedfeatures" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 <param label="--p-no-plot-observed-features-ratio: Do not plot ratio of observed:expected features on score plot. [default: False]" name="pnoplotobservedfeaturesratio" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <param label="--m-metadata-column: COLUMN MetadataColumn[Categorical] Optional sample metadata that maps observed-features sample IDs to expected-features sample IDs. [optional]" name="mmetadatacolumn" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103
5
a025a4a89e07 Uploaded
florianbegusch
parents: 2
diff changeset
104 <param label="--m-metadata-file METADATA" name="metadatafile" type="data" format="tabular,qza,no_unzip.zip" />
a025a4a89e07 Uploaded
florianbegusch
parents: 2
diff changeset
105
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 Evaluate expected vs. observed taxonomic composition of samples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 ###############################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 This visualizer compares the feature composition of pairs of observed and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 expected samples containing the same sample ID in two separate feature
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 tables. Typically, feature composition will consist of taxonomy
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 classifications or other semicolon-delimited feature annotations. Taxon
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 accuracy rate, taxon detection rate, and linear regression scores between
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 expected and observed observations are calculated at each semicolon-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 delimited rank, and plots of per-level accuracy and observation
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 correlations are plotted. A histogram of distance between false positive
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 observations and the nearest expected feature is also generated, where
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 distance equals the number of rank differences between the observed feature
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 and the nearest common lineage in the expected feature. This visualizer is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 most suitable for testing per-run data quality on sequencing runs that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 contain mock communities or other samples with known composition. Also
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 suitable for sanity checks of bioinformatics pipeline performance.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 expected_features : FeatureTable[RelativeFrequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 Expected feature compositions
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 observed_features : FeatureTable[RelativeFrequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 Observed feature compositions
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 depth : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 Maximum depth of semicolon-delimited taxonomic ranks to test (e.g., 1 =
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138 root, 7 = species for the greengenes reference sequence database).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 palette : Str % Choices('Set1', 'Set2', 'Set3', 'Pastel1', 'Pastel2', 'Paired', 'Accent', 'Dark2', 'tab10', 'tab20', 'tab20b', 'tab20c', 'viridis', 'plasma', 'inferno', 'magma', 'terrain', 'rainbow'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140 Color palette to utilize for plotting.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141 plot_tar : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142 Plot taxon accuracy rate (TAR) on score plot. TAR is the number of true
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
143 positive features divided by the total number of observed features (TAR
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
144 = true positives / (true positives + false positives)).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
145 plot_tdr : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
146 Plot taxon detection rate (TDR) on score plot. TDR is the number of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
147 true positive features divided by the total number of expected features
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
148 (TDR = true positives / (true positives + false negatives)).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
149 plot_r_value : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
150 Plot expected vs. observed linear regression r value on score plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
151 plot_r_squared : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
152 Plot expected vs. observed linear regression r-squared value on score
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
153 plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
154 plot_bray_curtis : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
155 Plot expected vs. observed Bray-Curtis dissimilarity scores on score
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
156 plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
157 plot_jaccard : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
158 Plot expected vs. observed Jaccard distances scores on score plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
159 plot_observed_features : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
160 Plot observed features count on score plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
161 plot_observed_features_ratio : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
162 Plot ratio of observed:expected features on score plot.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
163 metadata : MetadataColumn[Categorical], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
164 Optional sample metadata that maps observed_features sample IDs to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
165 expected_features sample IDs.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
166
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
167 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
168 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
169 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
170 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
171 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
172 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
173 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
174 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
175 </tool>