annotate qiime2/qiime_sample-classifier_classify-samples-ncv.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_sample-classifier_classify-samples-ncv" name="qiime sample-classifier classify-samples-ncv" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Nested cross-validated supervised learning classifier.</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 sample-classifier classify-samples-ncv
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --m-metadata-column="$mmetadatacolumn"
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
a025a4a89e07 Uploaded
florianbegusch
parents: 2
diff changeset
15 #if $metadatafile:
a025a4a89e07 Uploaded
florianbegusch
parents: 2
diff changeset
16 --m-metadata-file=$metadatafile
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
19
6
florianbegusch
parents: 5
diff changeset
20 #if str($pcv):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 --p-cv=$pcv
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #if str($prandomstate):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 --p-random-state="$prandomstate"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #set $pnjobs = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #if str($pnjobs):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --p-n-jobs="$pnjobs"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34
6
florianbegusch
parents: 5
diff changeset
35 #if str($pnestimators):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 --p-n-estimators=$pnestimators
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 #if str($pestimator) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 --p-estimator=$pestimator
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 #if $pparametertuning:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 --p-parameter-tuning
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 #if str($pmissingsamples) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 --p-missing-samples=$pmissingsamples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 --o-predictions=opredictions
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 --o-feature-importance=ofeatureimportance
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 cp opredictions.qza $opredictions;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 cp ofeatureimportance.qza $ofeatureimportance
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] Feature table containing all features that should be used for target prediction. [required]" name="itable" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <param label="--m-metadata-column: COLUMN MetadataColumn[Categorical] Categorical metadata column to use as prediction target. [required]" name="mmetadatacolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <param label="--p-cv: INTEGER Number of k-fold cross-validations to perform. Range(1, None) [default: 5]" name="pcv" optional="True" type="integer" value="5" min="1"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <param label="--p-random-state: INTEGER Seed used by random number generator. [optional]" name="prandomstate" optional="True" type="integer"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <param label="--p-n-estimators: INTEGER Range(1, None) Number of trees to grow for estimation. More trees will improve predictive accuracy up to a threshold level, but will also increase time and memory requirements. This parameter only affects ensemble estimators, such as Random Forest, AdaBoost, ExtraTrees, and GradientBoosting. [default: 100]" name="pnestimators" optional="True" type="integer" value="100" min="1"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <param label="--p-estimator: " name="pestimator" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <option value="RandomForestClassifier">RandomForestClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <option value="ExtraTreesClassifier">ExtraTreesClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <option value="GradientBoostingClassifier">GradientBoostingClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 <option value="AdaBoostClassifier">AdaBoostClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <option value="KNeighborsClassifier">KNeighborsClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <option value="LinearSVC">LinearSVC</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <option value="SVC">SVC</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <param label="--p-parameter-tuning: --p-no-parameter-tuning Automatically tune hyperparameters using random grid search. [default: False]" name="pparametertuning" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <param label="--p-missing-samples: " name="pmissingsamples" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <option value="error">error</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <option value="ignore">ignore</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79
5
a025a4a89e07 Uploaded
florianbegusch
parents: 2
diff changeset
80 <param label="--m-metadata-file METADATA" name="metadatafile" type="data" format="tabular,qza,no_unzip.zip" />
a025a4a89e07 Uploaded
florianbegusch
parents: 2
diff changeset
81
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <data format="qza" label="${tool.name} on ${on_string}: predictions.qza" name="opredictions"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 <data format="qza" label="${tool.name} on ${on_string}: featureimportance.qza" name="ofeatureimportance"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 Nested cross-validated supervised learning classifier.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 ######################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 Predicts a categorical sample metadata column using a supervised learning
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 classifier. Uses nested stratified k-fold cross validation for automated
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 hyperparameter optimization and sample prediction. Outputs predicted values
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 for each input sample, and relative importance of each feature for model
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 accuracy.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 Feature table containing all features that should be used for target
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 prediction.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 metadata : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 Categorical metadata column to use as prediction target.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 cv : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 Number of k-fold cross-validations to perform.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 random_state : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 Seed used by random number generator.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 n_estimators : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 Number of trees to grow for estimation. More trees will improve
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 predictive accuracy up to a threshold level, but will also increase
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 time and memory requirements. This parameter only affects ensemble
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 estimators, such as Random Forest, AdaBoost, ExtraTrees, and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 GradientBoosting.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 estimator : Str % Choices('RandomForestClassifier', 'ExtraTreesClassifier', 'GradientBoostingClassifier', 'AdaBoostClassifier', 'KNeighborsClassifier', 'LinearSVC', 'SVC'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 Estimator method to use for sample prediction.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 parameter_tuning : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 Automatically tune hyperparameters using random grid search.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 missing_samples : Str % Choices('error', 'ignore'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 How to handle missing samples in metadata. "error" will fail if missing
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 samples are detected. "ignore" will cause the feature table and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 metadata to be filtered, so that only samples found in both files are
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 retained.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 predictions : SampleData[ClassifierPredictions]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 Predicted target values for each input sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 feature_importance : FeatureData[Importance]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 Importance of each input feature to model accuracy.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 </tool>