annotate qiime2/qiime_sample-classifier_regress-samples.xml @ 0:51b9b6b57732 draft

Uploaded
author florianbegusch
date Thu, 24 May 2018 05:21:07 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_sample-classifier_regress-samples" name="qiime sample-classifier regress-samples" version="2018.4">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Supervised learning regressor.</description>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2018.4">qiime2</requirement>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
7 <command>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
8 <![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
9 qiime sample-classifier regress-samples --i-table=$itable
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
10
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
11 #def list_dict_to_string(list_dict):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
12 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
13 #for d in list_dict[1:]:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
14 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
15 #end for
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
16 #return $file_list
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
17 #end def
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
18
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
19 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile) --m-metadata-column="$mmetadatacolumn"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
20 #set $pnjobs = '${GALAXY_SLOTS:-4}'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
21
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
22 #if str($pnjobs):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
23 --p-n-jobs="$pnjobs"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
25
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
26
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
27 #if $pstep:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
28 --p-step=$pstep
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
30
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
31 #if $pstratify:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
32 --p-stratify
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
33 #else
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
34 --p-no-stratify
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
35 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
36
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
37 #if $poptimizefeatureselection:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
38 --p-optimize-feature-selection
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
39 #else
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
40 --p-no-optimize-feature-selection
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
41 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
42
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
43 #if $ptestsize:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
44 --p-test-size=$ptestsize
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
45 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
46 --o-visualization=ovisualization
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
47 #if str($pestimator) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
48 --p-estimator=$pestimator
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
49 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
50
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
51 #if $pnestimators:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
52 --p-n-estimators=$pnestimators
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
53 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
54
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
55 #if str($cmdconfig) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
56 --cmd-config=$cmdconfig
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
57 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
58
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
59 #if $pcv:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
60 --p-cv=$pcv
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
61 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
62
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
63 #if $pparametertuning:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
64 --p-parameter-tuning
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
65 #else
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
66 --p-no-parameter-tuning
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
67 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
68
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
69 #if str($prandomstate):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
70 --p-random-state="$prandomstate"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
71 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
72 ;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
73 qiime tools export ovisualization.qzv --output-dir out && mkdir -p '$ovisualization.files_path'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
74 && cp -r out/* '$ovisualization.files_path'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
75 && mv '$ovisualization.files_path/index.html' '$ovisualization'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
76 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
77 </command>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
78 <inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
79 <param format="qza,no_unzip.zip" label="--i-table: FeatureTable[Frequency] Feature table containing all features that should be used for target prediction. [required]" name="itable" optional="False" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
80 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
81 <param label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [required]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
82 </repeat>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
83 <param label="--m-metadata-column: MetadataColumn[Numeric] Column from metadata file or artifact viewable as metadata. Numeric metadata column to use as prediction target. [required]" name="mmetadatacolumn" optional="False" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
84
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
85 <param label="--p-test-size: 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"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
86
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
87 <param label="--p-step: 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"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
88
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
89 <param label="--p-cv: Number of k-fold cross-validations to perform. [default: 5]" name="pcv" optional="True" type="integer" value="5"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
90
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
91 <param label="--p-random-state: Seed used by random number generator. [optional]" name="prandomstate" optional="True" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
92
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
93 <param label="--p-n-estimators: 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"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
94 <param label="--p-estimator: Estimator method to use for sample
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
95 prediction. [default:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
96 RandomForestRegressor]" name="pestimator" optional="True" type="select">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
97 <option selected="True" value="None">Selection is Optional</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
98 <option value="Ridge">Ridge</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
99 <option value="RandomForestRegressor">RandomForestRegressor</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
100 <option value="GradientBoostingRegressor">GradientBoostingRegressor</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
101 <option value="AdaBoostRegressor">AdaBoostRegressor</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
102 <option value="LinearSVR">LinearSVR</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
103 <option value="ExtraTreesRegressor">ExtraTreesRegressor</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
104 <option value="KNeighborsRegressor">KNeighborsRegressor</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
105 <option value="SVR">SVR</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
106 <option value="ElasticNet">ElasticNet</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
107 <option value="Lasso">Lasso</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
108 </param>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
109
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
110 <param label="--p-optimize-feature-selection: --p-no-optimize-feature-selection Automatically optimize input feature selection using recursive feature elimination. [default: False]" name="poptimizefeatureselection" checked="False" type="boolean"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
111
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
112 <param label="--p-stratify: --p-no-stratify Evenly stratify training and test data among metadata categories. If True, all values in column must match at least two samples. [default: False]" name="pstratify" checked="False" type="boolean"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
113
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
114 <param label="--p-parameter-tuning: --p-no-parameter-tuning Automatically tune hyperparameters using random grid search. [default: False]" name="pparametertuning" checked="False" type="boolean"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
115
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
116 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
117 </inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
118 <outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
119 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
120 </outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
121 <help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
122 <![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
123 Supervised learning regressor.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
124 -------------------------------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
125
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
126 Predicts a continuous sample metadata column using a supervised learning
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
127 regressor. Splits input data into training and test sets. The training set
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
128 is used to train and test the estimator using a stratified k-fold cross-
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
129 validation scheme. This includes optional steps for automated feature
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
130 extraction and hyperparameter optimization. The test set validates
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
131 classification accuracy of the optimized estimator. Outputs classification
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
132 results for test set. For more details on the learning algorithm, see
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
133 http://scikit-learn.org/stable/supervised_learning.html
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
134
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
135 Parameters
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
136 ----------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
137 table : FeatureTable[Frequency]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
138 Feature table containing all features that should be used for target
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
139 prediction.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
140 metadata : MetadataColumn[Numeric]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
141 Numeric metadata column to use as prediction target.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
142 test_size : Float % Range(0.0, 1.0, inclusive_start=False), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
143 Fraction of input samples to exclude from training set and use for
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
144 classifier testing.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
145 step : Float % Range(0.0, 1.0, inclusive_start=False), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
146 If optimize_feature_selection is True, step is the percentage of
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
147 features to remove at each iteration.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
148 cv : Int % Range(1, None), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
149 Number of k-fold cross-validations to perform.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
150 random_state : Int, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
151 Seed used by random number generator.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
152 n_estimators : Int % Range(1, None), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
153 Number of trees to grow for estimation. More trees will improve
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
154 predictive accuracy up to a threshold level, but will also increase
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
155 time and memory requirements. This parameter only affects ensemble
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
156 estimators, such as Random Forest, AdaBoost, ExtraTrees, and
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
157 GradientBoosting.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
158 estimator : Str % Choices({'AdaBoostRegressor', 'ElasticNet', 'ExtraTreesRegressor', 'GradientBoostingRegressor', 'KNeighborsRegressor', 'Lasso', 'LinearSVR', 'RandomForestRegressor', 'Ridge', 'SVR'}), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
159 Estimator method to use for sample prediction.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
160 optimize_feature_selection : Bool, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
161 Automatically optimize input feature selection using recursive feature
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
162 elimination.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
163 stratify : Bool, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
164 Evenly stratify training and test data among metadata categories. If
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
165 True, all values in column must match at least two samples.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
166 parameter_tuning : Bool, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
167 Automatically tune hyperparameters using random grid search.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
168
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
169 Returns
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
170 -------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
171 visualization : Visualization
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
172 \
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
173 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
174 </help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
175 <macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
176 <import>qiime_citation.xml</import>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
177 </macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
178 <expand macro="qiime_citation" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
179 </tool>