annotate qiime2/qiime_sample-classifier_fit-classifier.xml @ 5:a025a4a89e07 draft

Uploaded
author florianbegusch
date Mon, 05 Aug 2019 01:29:30 -0400
parents 370e0b6e9826
children de4c22a52df4
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_fit-classifier" name="qiime sample-classifier fit-classifier" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Fit a 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 fit-classifier
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
5
a025a4a89e07 Uploaded
florianbegusch
parents: 0
diff changeset
13 #if str($pstep):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 --p-step=$pstep
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #if $pcv:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --p-cv=$pcv
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($prandomstate):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --p-random-state="$prandomstate"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #set $pnjobs = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #if str($pnjobs):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 --p-n-jobs="$pnjobs"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #if $pnestimators:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 --p-n-estimators=$pnestimators
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #if str($pestimator) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 --p-estimator=$pestimator
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 #if $poptimizefeatureselection:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 --p-optimize-feature-selection
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 #if $pparametertuning:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 --p-parameter-tuning
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 #if str($pmissingsamples) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 --p-missing-samples=$pmissingsamples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52
5
a025a4a89e07 Uploaded
florianbegusch
parents: 0
diff changeset
53
a025a4a89e07 Uploaded
florianbegusch
parents: 0
diff changeset
54 #if $metadatafile:
a025a4a89e07 Uploaded
florianbegusch
parents: 0
diff changeset
55 --m-metadata-file=$metadatafile
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58
5
a025a4a89e07 Uploaded
florianbegusch
parents: 0
diff changeset
59
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 --o-sample-estimator=osampleestimator
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 --o-feature-importance=ofeatureimportance
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 cp osampleestimator.qza $osampleestimator;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 cp ofeatureimportance.qza $ofeatureimportance
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <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
68 <param label="--m-metadata-column: COLUMN MetadataColumn[Categorical] Numeric metadata column to use as prediction target. [required]" name="mmetadatacolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <param label="--p-step: PROPORTION Range(0.0, 1.0, inclusive_start=False) If optimize-feature-selection is True, step is the percentage of features to remove at each iteration. [default: 0.05]" name="pstep" optional="True" type="float" value="0.05" min="0" max="1" exclusive_start="True"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <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
71 <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
72 <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
73 <param label="--p-estimator: " name="pestimator" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <option value="RandomForestClassifier">RandomForestClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <option value="ExtraTreesClassifier">ExtraTreesClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <option value="GradientBoostingClassifier">GradientBoostingClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <option value="AdaBoostClassifier">AdaBoostClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <option value="KNeighborsClassifier">KNeighborsClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <option value="LinearSVC">LinearSVC</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 <option value="SVC">SVC</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <param label="--p-optimize-feature-selection: --p-no-optimize-feature-selection Automatically optimize input feature selection using recursive feature elimination. [default: False]" name="poptimizefeatureselection" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <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
85 <param label="--p-missing-samples: " name="pmissingsamples" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 <option value="error">error</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <option value="ignore">ignore</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90
5
a025a4a89e07 Uploaded
florianbegusch
parents: 0
diff changeset
91 <param label="--m-metadata-file METADATA" name="metadatafile" type="data" format="tabular,qza,no_unzip.zip" />
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 <data format="qza" label="${tool.name} on ${on_string}: sampleestimator.qza" name="osampleestimator"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 <data format="qza" label="${tool.name} on ${on_string}: featureimportance.qza" name="ofeatureimportance"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 Fit a supervised learning classifier.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 #####################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 Fit a supervised learning classifier. Outputs the fit estimator (for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 prediction of test samples and/or unknown samples) and the relative
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 importance of each feature for model accuracy. Optionally use k-fold cross-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 validation for automatic recursive feature elimination and hyperparameter
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 tuning.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 Feature table containing all features that should be used for target
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 prediction.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 metadata : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 Numeric metadata column to use as prediction target.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 step : Float % Range(0.0, 1.0, inclusive_start=False), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 If optimize_feature_selection is True, step is the percentage of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 features to remove at each iteration.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 cv : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 Number of k-fold cross-validations to perform.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 random_state : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 Seed used by random number generator.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 n_estimators : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 Number of trees to grow for estimation. More trees will improve
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 predictive accuracy up to a threshold level, but will also increase
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 time and memory requirements. This parameter only affects ensemble
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 estimators, such as Random Forest, AdaBoost, ExtraTrees, and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 GradientBoosting.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 estimator : Str % Choices('RandomForestClassifier', 'ExtraTreesClassifier', 'GradientBoostingClassifier', 'AdaBoostClassifier', 'KNeighborsClassifier', 'LinearSVC', 'SVC'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 Estimator method to use for sample prediction.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 optimize_feature_selection : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 Automatically optimize input feature selection using recursive feature
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 elimination.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 parameter_tuning : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 Automatically tune hyperparameters using random grid search.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 missing_samples : Str % Choices('error', 'ignore'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 How to handle missing samples in metadata. "error" will fail if missing
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 samples are detected. "ignore" will cause the feature table and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138 metadata to be filtered, so that only samples found in both files are
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 retained.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
143 sample_estimator : SampleEstimator[Classifier]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
144 Trained sample classifier.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
145 feature_importance : FeatureData[Importance]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
146 Importance of each input feature to model accuracy.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
147 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
148 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
149 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
150 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
151 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
152 </tool>