annotate qiime_feature-classifier_classify-sklearn.xml @ 1:f2028d8efed6 draft default tip

Add tool_data_table_conf.xml.sample
author florianbegusch
date Thu, 24 May 2018 03:40:50 -0400
parents 09b7bcb72fa7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_feature-classifier_classify-sklearn" name="qiime feature-classifier classify-sklearn" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description>- Pre-fitted sklearn-based taxonomy classifier</description>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2018.4">qiime2</requirement>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
8 qiime feature-classifier classify-sklearn
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
9
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
10 #if str( $id_to_classifier_fp.selector ) == 'history'
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
11 #set $classifier = $id_to_classifier_fp.classifier_fp
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
12 --i-classifier '$classifier'
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
13 #else:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
14 #set $classifier = $id_to_classifier_fp.classifier.fields.path
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
15 --i-classifier '$classifier'
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
17
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
18 --i-reads=$ireads
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
19
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
20 #if str($pconfidence) != '':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
21 #if float($pconfidence) >= 0.0:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
22 --p-confidence=$pconfidence
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26 #if str($preadorientation) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27 --p-read-orientation=$preadorientation
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30 #if str($cmdconfig) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31 --cmd-config=$cmdconfig
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
33
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
34 #set $pnjobs = '${GALAXY_SLOTS:-4}'
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35 --p-n-jobs="$pnjobs"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36 --o-classification=oclassification;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
37
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38 cp oclassification.qza $oclassification;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
39 ]]></command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41 <param format="qza,no_unzip.zip" label="--i-reads: FeatureData[Sequence] The feature data to be classified. [required]" name="ireads" optional="False" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43 <conditional name="id_to_classifier_fp" optional="True">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 <param name="selector" type="select" label="Reference classifier to query">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45 <option value="cached">Public classifiers</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46 <option value="history">Classifiers from your history</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47 </param>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48 <when value="cached">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49 <param name="classifier_fp" label="Reference classifier" type="select" optional="True">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50 <options from_data_table="qiime_taxonomy" />
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
51 </param>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
52 </when>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
53 <when value="history">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
54 <param name="classifier_fp" type="data" format="qza,no_unzip.zip" label="Reference classifier" optional="True" />
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
55 </when>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
56 </conditional>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
57
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
58 <param label="--p-confidence: Confidence threshold for limiting taxonomic depth. Provide -1 to disable confidence calculation, or 0 to calculate confidence but not apply it to limit the taxonomic depth of the assignments. [default: 0.7]" name="pconfidence" optional="True" type="float" value="0.7"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
59 <param label="--p-read-orientation: [reverse-complement|same] Direction of reads with respect to reference sequences. same will cause reads to be classified unchanged; reverse-complement will cause reads to be reversed and complemented prior to classification. Default is to autodetect based on the confidence estimates for the first 100 reads. [optional]" name="preadorientation" optional="True" type="select">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
60 <option selected="True" value="None">Selection is Optional</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
61 <option value="reverse-complement">reverse-complement</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
62 <option value="same">same</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
63 </param>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
64 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
65 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
66 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
67 <data format="qza" label="${tool.name} on ${on_string}: classification.qza" name="oclassification"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
68 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
69 <help><![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
70 Pre-fitted sklearn-based taxonomy classifier
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
71 ---------------------------------------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
72
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
73 Classify reads by taxon using a fitted classifier.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
74
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
75 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
76 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
77 reads : FeatureData[Sequence]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
78 The feature data to be classified.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
79 classifier : TaxonomicClassifier
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
80 The taxonomic classifier for classifying the reads.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
81 reads_per_batch : Int % Range(0, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
82 Number of reads to process in each batch. If 0, this parameter is
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
83 autoscaled to the number of query sequences / n_jobs.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
84 pre_dispatch : Str, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
85 "all" or expression, as in "3*n_jobs". The number of batches (of tasks)
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
86 to be pre-dispatched.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
87 confidence : Float, optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
88 Confidence threshold for limiting taxonomic depth. Provide -1 to
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
89 disable confidence calculation, or 0 to calculate confidence but not
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
90 apply it to limit the taxonomic depth of the assignments.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
91 read_orientation : Str % Choices({'reverse-complement', 'same'}), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
92 Direction of reads with respect to reference sequences. same will cause
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
93 reads to be classified unchanged; reverse-complement will cause reads
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
94 to be reversed and complemented prior to classification. Default is to
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
95 autodetect based on the confidence estimates for the first 100 reads.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
96
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
97 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
98 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
99 classification : FeatureData[Taxonomy]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
100 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
101 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
102 </tool>