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

Fixes
author florianbegusch
date Tue, 13 Aug 2019 07:46:48 -0400
parents 370e0b6e9826
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-taxonomy" name="qiime quality-control evaluate-taxonomy" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Evaluate expected vs. observed taxonomic assignments</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-taxonomy
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-expected-taxa=$iexpectedtaxa
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-observed-taxa=$iobservedtaxa
6
florianbegusch
parents: 0
diff changeset
12
florianbegusch
parents: 0
diff changeset
13 #if str($pdepth):
florianbegusch
parents: 0
diff changeset
14 --p-depth="$pdepth"
florianbegusch
parents: 0
diff changeset
15 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #if str($ifeaturetable) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --i-feature-table=$ifeaturetable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($ppalette) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --p-palette=$ppalette
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #if $pnorequireexpids:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 --p-no-require-exp-ids
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #if $pnorequireobsids:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 --p-no-require-obs-ids
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #if str($psampleid):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 --p-sample-id="$psampleid"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <param format="qza,no_unzip.zip" label="--i-expected-taxa: ARTIFACT FeatureData[Taxonomy] Expected taxonomic assignments [required]" name="iexpectedtaxa" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <param format="qza,no_unzip.zip" label="--i-observed-taxa: ARTIFACT FeatureData[Taxonomy] Observed taxonomic assignments [required]" name="iobservedtaxa" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <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). [required]" name="pdepth" optional="False" value="" type="integer"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <param format="qza,no_unzip.zip" label="--i-feature-table: ARTIFACT FeatureTable[RelativeFrequency] Optional feature table containing relative frequency of each feature, used to weight accuracy scores by frequency. Must contain all features found in expected and/or observed taxa. Features found in the table but not the expected/observed taxa will be dropped prior to analysis. [optional]" name="ifeaturetable" optional="True" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <param label="--p-palette: " name="ppalette" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <option value="Set1">Set1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <option value="Set2">Set2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <option value="Set3">Set3</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <option value="Pastel1">Pastel1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <option value="Pastel2">Pastel2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <option value="Paired">Paired</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <option value="Accent">Accent</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <option value="Dark2">Dark2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <option value="tab10">tab10</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <option value="tab20">tab20</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <option value="tab20b">tab20b</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <option value="tab20c">tab20c</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <option value="viridis">viridis</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <option value="plasma">plasma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 <option value="inferno">inferno</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <option value="magma">magma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <option value="terrain">terrain</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <option value="rainbow">rainbow</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <param label="--p-no-require-exp-ids: Do not require that all features found in observed taxa must be found in expected taxa or raise error. [default: False]" name="pnorequireexpids" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <param label="--p-no-require-obs-ids: Require that all features found in expected taxa must be found in observed taxa or raise error. [default: False]" name="pnorequireobsids" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <param label="--p-sample-id: TEXT Optional sample ID to use for extracting frequency data from feature table, and for labeling accuracy results. If no sample-id is provided, feature frequencies are derived from the sum of all samples present in the feature table. [optional]" name="psampleid" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 Evaluate expected vs. observed taxonomic assignments
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 ####################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 This visualizer compares a pair of observed and expected taxonomic
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 assignments to calculate precision, recall, and F-measure at each taxonomic
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 level, up to maximum level specified by the depth parameter. These metrics
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 are calculated at each semicolon-delimited rank. This action is useful for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 comparing the accuracy of taxonomic assignment, e.g., between different
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 taxonomy classifiers or other bioinformatics methods. Expected taxonomies
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 should be derived from simulated or mock community sequences that have
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 known taxonomic affiliations.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 expected_taxa : FeatureData[Taxonomy]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 Expected taxonomic assignments
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 observed_taxa : FeatureData[Taxonomy]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 Observed taxonomic assignments
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 depth : Int
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 Maximum depth of semicolon-delimited taxonomic ranks to test (e.g., 1 =
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 root, 7 = species for the greengenes reference sequence database).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 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
99 Color palette to utilize for plotting.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 require_exp_ids : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 Require that all features found in observed taxa must be found in
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 expected taxa or raise error.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 require_obs_ids : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 Require that all features found in expected taxa must be found in
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 observed taxa or raise error.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 feature_table : FeatureTable[RelativeFrequency], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 Optional feature table containing relative frequency of each feature,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 used to weight accuracy scores by frequency. Must contain all features
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 found in expected and/or observed taxa. Features found in the table but
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 not the expected/observed taxa will be dropped prior to analysis.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 sample_id : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 Optional sample ID to use for extracting frequency data from feature
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 table, and for labeling accuracy results. If no sample_id is provided,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 feature frequencies are derived from the sum of all samples present in
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 the feature table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 </tool>