annotate qiime2-2020.8/qiime_feature-classifier_classify-sklearn.xml @ 20:d93d8888f0b0 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:44:24 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_feature-classifier_classify-sklearn" name="qiime feature-classifier classify-sklearn"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Pre-fitted sklearn-based taxonomy classifier</description>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
9 qiime feature-classifier classify-sklearn
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-reads=$ireads
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 --i-classifier=$iclassifier
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 --p-n-jobs=$pnjobs
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 #if str($pconfidence) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18 --p-confidence=$pconfidence
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($preadorientation) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22 --p-read-orientation=$preadorientation
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25 --o-classification=oclassification
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
30
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32 cp oclassification.qza $oclassification
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35 <inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36 <param format="qza,no_unzip.zip" label="--i-reads: ARTIFACT FeatureData[Sequence] The feature data to be classified. [required]" name="ireads" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37 <param format="qza,no_unzip.zip" label="--i-classifier: ARTIFACT TaxonomicClassifier The taxonomic classifier for classifying the reads. [required]" name="iclassifier" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38 <param label="--p-confidence: " name="pconfidence" optional="True" type="select">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39 <option selected="True" value="None">Selection is Optional</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40 <option value="Float % Range(0">Float % Range(0</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41 <option value="1">1</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42 <option value="inclusive_end=True">inclusive_end=True</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43 </param>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 <param label="--p-read-orientation: " name="preadorientation" optional="True" type="select">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45 <option selected="True" value="None">Selection is Optional</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46 <option value="same">same</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 <option value="reverse-complement">reverse-complement</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48 <option value="auto">auto</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 </param>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 <data format="qza" label="${tool.name} on ${on_string}: classification.qza" name="oclassification" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60 Pre-fitted sklearn-based taxonomy classifier
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 Classify reads by taxon using a fitted classifier.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67 reads : FeatureData[Sequence]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 The feature data to be classified.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69 classifier : TaxonomicClassifier
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
70 The taxonomic classifier for classifying the reads.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
71 reads_per_batch : Int % Range(0, None), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
72 Number of reads to process in each batch. If "auto", this parameter is
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
73 autoscaled to min( number of query sequences / n_jobs, 20000).
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
74 n_jobs : Int, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
75 The maximum number of concurrently worker processes. If -1 all CPUs are
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
76 used. If 1 is given, no parallel computing code is used at all, which
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
77 is useful for debugging. For n_jobs below -1, (n_cpus + 1 + n_jobs) are
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
78 used. Thus for n_jobs = -2, all CPUs but one are used.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
79 pre_dispatch : Str, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
80 "all" or expression, as in "3*n_jobs". The number of batches (of tasks)
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
81 to be pre-dispatched.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
82 confidence : Float % Range(0, 1, inclusive_end=True) | Str % Choices('disable'), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
83 Confidence threshold for limiting taxonomic depth. Set to "disable" to
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
84 disable confidence calculation, or 0 to calculate confidence but not
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
85 apply it to limit the taxonomic depth of the assignments.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
86 read_orientation : Str % Choices('same', 'reverse-complement', 'auto'), optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
87 Direction of reads with respect to reference sequences. same will cause
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
88 reads to be classified unchanged; reverse-complement will cause reads
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
89 to be reversed and complemented prior to classification. "auto" will
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
90 autodetect orientation based on the confidence estimates for the first
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
91 100 reads.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
92
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
93 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
94 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
95 classification : FeatureData[Taxonomy]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
96 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
97 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
98 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
99 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
100 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
101 </tool>