annotate qiime2/qiime_sample-classifier_classify-samples.xml @ 4:914fa4daf16a draft

Fixes
author florianbegusch
date Wed, 31 Jul 2019 03:06:00 -0400
parents 370e0b6e9826
children a025a4a89e07
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" name="qiime sample-classifier classify-samples" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Train and test a 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
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
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 #if $ptestsize:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 --p-test-size=$ptestsize
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #if $pstep:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --p-step=$pstep
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #if $pcv:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 --p-cv=$pcv
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #if str($prandomstate):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 --p-random-state="$prandomstate"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #set $pnjobs = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #if str($pnjobs):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 --p-n-jobs="$pnjobs"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #if $pnestimators:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 --p-n-estimators=$pnestimators
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 #if str($pestimator) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 --p-estimator=$pestimator
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 #if $poptimizefeatureselection:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 --p-optimize-feature-selection
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 #if $pparametertuning:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 --p-parameter-tuning
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 #if str($ppalette) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 --p-palette=$ppalette
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 #if str($pmissingsamples) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 --p-missing-samples=$pmissingsamples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 --o-sample-estimator=osampleestimator
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 --o-feature-importance=ofeatureimportance
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 --o-predictions=opredictions
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 --o-model-summary=omodelsummary
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 --o-accuracy-results=oaccuracyresults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 cp osampleestimator.qza $osampleestimator;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 cp ofeatureimportance.qza $ofeatureimportance;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 cp opredictions.qza $opredictions;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 qiime tools export --input-path omodelsummary.qzv --output-path out && mkdir -p '$omodelsummary.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 && cp -r out/* '$omodelsummary.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 && mv '$omodelsummary.files_path/index.html' '$omodelsummary';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 qiime tools export --input-path oaccuracyresults.qzv --output-path out && mkdir -p '$oaccuracyresults.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 && cp -r out/* '$oaccuracyresults.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 && mv '$oaccuracyresults.files_path/index.html' '$oaccuracyresults'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 <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
91 <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
92 <param label="--p-test-size: PROPORTION Range(0.0, 1.0, inclusive_start=False) Fraction of input samples to exclude from training set and use for classifier testing. [default: 0.2]" name="ptestsize" optional="True" type="float" value="0.2" min="0" max="1" exclusive_start="True"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 <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
94 <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
95 <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
96 <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
97 <param label="--p-estimator: " name="pestimator" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <option value="RandomForestClassifier">RandomForestClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <option value="ExtraTreesClassifier">ExtraTreesClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 <option value="GradientBoostingClassifier">GradientBoostingClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <option value="AdaBoostClassifier">AdaBoostClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 <option value="KNeighborsClassifier">KNeighborsClassifier</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 <option value="LinearSVC">LinearSVC</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 <option value="SVC">SVC</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 <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
108 <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
109 <param label="--p-palette: " name="ppalette" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 <option value="YellowOrangeBrown">YellowOrangeBrown</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 <option value="YellowOrangeRed">YellowOrangeRed</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 <option value="OrangeRed">OrangeRed</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 <option value="PurpleRed">PurpleRed</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 <option value="RedPurple">RedPurple</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 <option value="BluePurple">BluePurple</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 <option value="GreenBlue">GreenBlue</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 <option value="PurpleBlue">PurpleBlue</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 <option value="YellowGreen">YellowGreen</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 <option value="summer">summer</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 <option value="copper">copper</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 <option value="viridis">viridis</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 <option value="plasma">plasma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 <option value="inferno">inferno</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 <option value="magma">magma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 <option value="sirocco">sirocco</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 <option value="drifting">drifting</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 <option value="melancholy">melancholy</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 <option value="enigma">enigma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 <option value="eros">eros</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 <option value="spectre">spectre</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 <option value="ambition">ambition</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 <option value="mysteriousstains">mysteriousstains</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 <option value="daydream">daydream</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 <option value="solano">solano</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 <option value="navarro">navarro</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 <option value="dandelions">dandelions</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138 <option value="deepblue">deepblue</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 <option value="verve">verve</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140 <option value="greyscale">greyscale</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142 <param label="--p-missing-samples: " name="pmissingsamples" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
143 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
144 <option value="error">error</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
145 <option value="ignore">ignore</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
146 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
147
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
148 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
149 <param label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [optional]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
150 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
151
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
152 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
153 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
154 <data format="qza" label="${tool.name} on ${on_string}: sampleestimator.qza" name="osampleestimator"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
155 <data format="qza" label="${tool.name} on ${on_string}: featureimportance.qza" name="ofeatureimportance"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
156 <data format="qza" label="${tool.name} on ${on_string}: predictions.qza" name="opredictions"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
157 <data format="html" label="${tool.name} on ${on_string}: modelsummary.qzv" name="omodelsummary"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
158 <data format="html" label="${tool.name} on ${on_string}: accuracyresults.qzv" name="oaccuracyresults"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
159 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
160 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
161 Train and test a cross-validated supervised learning classifier.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
162 ################################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
163
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
164 Predicts a categorical sample metadata column using a supervised learning
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
165 classifier. Splits input data into training and test sets. The training set
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
166 is used to train and test the estimator using a stratified k-fold cross-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
167 validation scheme. This includes optional steps for automated feature
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
168 extraction and hyperparameter optimization. The test set validates
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
169 classification accuracy of the optimized estimator. Outputs classification
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
170 results for test set. For more details on the learning algorithm, see
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
171 http://scikit-learn.org/stable/supervised_learning.html
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
172
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
173 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
174 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
175 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
176 Feature table containing all features that should be used for target
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
177 prediction.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
178 metadata : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
179 Categorical metadata column to use as prediction target.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
180 test_size : Float % Range(0.0, 1.0, inclusive_start=False), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
181 Fraction of input samples to exclude from training set and use for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
182 classifier testing.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
183 step : Float % Range(0.0, 1.0, inclusive_start=False), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
184 If optimize_feature_selection is True, step is the percentage of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
185 features to remove at each iteration.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
186 cv : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
187 Number of k-fold cross-validations to perform.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
188 random_state : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
189 Seed used by random number generator.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
190 n_estimators : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
191 Number of trees to grow for estimation. More trees will improve
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
192 predictive accuracy up to a threshold level, but will also increase
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
193 time and memory requirements. This parameter only affects ensemble
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
194 estimators, such as Random Forest, AdaBoost, ExtraTrees, and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
195 GradientBoosting.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
196 estimator : Str % Choices('RandomForestClassifier', 'ExtraTreesClassifier', 'GradientBoostingClassifier', 'AdaBoostClassifier', 'KNeighborsClassifier', 'LinearSVC', 'SVC'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
197 Estimator method to use for sample prediction.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
198 optimize_feature_selection : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
199 Automatically optimize input feature selection using recursive feature
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
200 elimination.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
201 parameter_tuning : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
202 Automatically tune hyperparameters using random grid search.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
203 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
204 The color palette to use for plotting.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
205 missing_samples : Str % Choices('error', 'ignore'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
206 How to handle missing samples in metadata. "error" will fail if missing
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
207 samples are detected. "ignore" will cause the feature table and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
208 metadata to be filtered, so that only samples found in both files are
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
209 retained.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
210
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
211 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
212 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
213 sample_estimator : SampleEstimator[Classifier]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
214 Trained sample estimator.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
215 feature_importance : FeatureData[Importance]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
216 Importance of each input feature to model accuracy.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
217 predictions : SampleData[ClassifierPredictions]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
218 Predicted target values for each input sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
219 model_summary : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
220 Summarized parameter and (if enabled) feature selection information for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
221 the trained estimator.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
222 accuracy_results : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
223 Accuracy results visualization.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
224 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
225 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
226 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
227 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
228 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
229 </tool>