annotate qiime2/qiime_sample-classifier_confusion-matrix.xml @ 9:f190567fe3f6 draft

Uploaded
author florianbegusch
date Wed, 14 Aug 2019 15:12:48 -0400
parents 370e0b6e9826
children a0a8d77a991c
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" ?>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 0
diff changeset
2 <tool id="qiime_sample-classifier_confusion-matrix" name="qiime sample-classifier confusion-matrix" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Make a confusion matrix from sample classifier predictions.</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 0
diff changeset
5 <requirement type="package" version="2019.7">qiime2</requirement>
0
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 sample-classifier confusion-matrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-predictions=$ipredictions
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --m-truth-column="$mtruthcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --m-truth-file=mtruthfile
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #if str($pmissingsamples) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 --p-missing-samples=$pmissingsamples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #if str($ppalette) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --p-palette=$ppalette
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 && mv '$ovisualization.files_path/index.html' '$ovisualization';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 cp mtruthfile.qza $mtruthfile
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 <param format="qza,no_unzip.zip" label="--i-predictions: ARTIFACT SampleData[ClassifierPredictions] Predicted values to plot on x axis. Should be predictions of categorical data produced by a sample classifier. [required]" name="ipredictions" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 <param label="--m-truth-column: COLUMN MetadataColumn[Categorical] Metadata column (true values) to plot on y axis. [required]" name="mtruthcolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 <param label="--p-missing-samples: " name="pmissingsamples" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 <option value="error">error</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 <option value="ignore">ignore</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 <param label="--p-palette: " name="ppalette" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 <option value="YellowOrangeBrown">YellowOrangeBrown</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 <option value="YellowOrangeRed">YellowOrangeRed</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <option value="OrangeRed">OrangeRed</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <option value="PurpleRed">PurpleRed</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <option value="RedPurple">RedPurple</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <option value="BluePurple">BluePurple</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <option value="GreenBlue">GreenBlue</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <option value="PurpleBlue">PurpleBlue</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <option value="YellowGreen">YellowGreen</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <option value="summer">summer</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <option value="copper">copper</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <option value="viridis">viridis</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <option value="plasma">plasma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <option value="inferno">inferno</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <option value="magma">magma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <option value="sirocco">sirocco</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <option value="drifting">drifting</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <option value="melancholy">melancholy</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <option value="enigma">enigma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <option value="eros">eros</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <option value="spectre">spectre</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <option value="ambition">ambition</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <option value="mysteriousstains">mysteriousstains</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <option value="daydream">daydream</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <option value="solano">solano</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 <option value="navarro">navarro</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <option value="dandelions">dandelions</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <option value="deepblue">deepblue</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <option value="verve">verve</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 <option value="greyscale">greyscale</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <data format="qza" label="${tool.name} on ${on_string}: truthfile.qza" name="mtruthfile"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 Make a confusion matrix from sample classifier predictions.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 ###########################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 Make a confusion matrix and calculate accuracy of predicted vs. true values
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 for a set of samples classified using a sample classifier.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 predictions : SampleData[ClassifierPredictions]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 Predicted values to plot on x axis. Should be predictions of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 categorical data produced by a sample classifier.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 truth : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 Metadata column (true values) to plot on y axis.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 missing_samples : Str % Choices('error', 'ignore'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 How to handle missing samples in metadata. "error" will fail if missing
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 samples are detected. "ignore" will cause the feature table and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 metadata to be filtered, so that only samples found in both files are
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 retained.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 palette : Str % Choices('YellowOrangeBrown', 'YellowOrangeRed', 'OrangeRed', 'PurpleRed', 'RedPurple', 'BluePurple', 'GreenBlue', 'PurpleBlue', 'YellowGreen', 'summer', 'copper', 'viridis', 'plasma', 'inferno', 'magma', 'sirocco', 'drifting', 'melancholy', 'enigma', 'eros', 'spectre', 'ambition', 'mysteriousstains', 'daydream', 'solano', 'navarro', 'dandelions', 'deepblue', 'verve', 'greyscale'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 The color palette to use for plotting.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 </tool>