annotate qiime2/qiime_longitudinal_maturity-index.xml @ 1:255f48db74f8 draft

Hotfix
author florianbegusch
date Wed, 17 Jul 2019 03:26:16 -0400
parents 370e0b6e9826
children 914fa4daf16a
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_longitudinal_maturity-index" name="qiime longitudinal maturity-index" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Microbial maturity index prediction.</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 longitudinal maturity-index
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --p-state-column="$pstatecolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --p-group-by="$pgroupby"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 --p-control="$pcontrol"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #if str($pindividualidcolumn):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 --p-individual-id-column="$pindividualidcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #if str($pestimator) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 --p-estimator=$pestimator
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #if $pnestimators:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 --p-n-estimators=$pnestimators
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #if $ptestsize:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 --p-test-size=$ptestsize
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #if $pstep:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 --p-step=$pstep
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 #if $pcv:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 --p-cv=$pcv
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($prandomstate):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 --p-random-state="$prandomstate"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 #set $pnjobs = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 #if str($pnjobs):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 --p-n-jobs="$pnjobs"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 #if $pparametertuning:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 --p-parameter-tuning
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 #if $poptimizefeatureselection:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 --p-optimize-feature-selection
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 #if $pstratify:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 --p-stratify
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 #if str($pmissingsamples) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 --p-missing-samples=$pmissingsamples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 #if $pfeaturecount:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 --p-feature-count=$pfeaturecount
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 --o-sample-estimator=osampleestimator
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 --o-feature-importance=ofeatureimportance
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 --o-predictions=opredictions
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 --o-model-summary=omodelsummary
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 --o-accuracy-results=oaccuracyresults
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 --o-maz-scores=omazscores
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 --o-clustermap=oclustermap
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 --o-volatility-plots=ovolatilityplots
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 cp osampleestimator.qza $osampleestimator;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 cp ofeatureimportance.qza $ofeatureimportance;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 cp opredictions.qza $opredictions;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 qiime tools export --input-path omodelsummary.qzv --output-path out && mkdir -p '$omodelsummary.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 && cp -r out/* '$omodelsummary.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 && mv '$omodelsummary.files_path/index.html' '$omodelsummary';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 qiime tools export --input-path oaccuracyresults.qzv --output-path out && mkdir -p '$oaccuracyresults.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 && cp -r out/* '$oaccuracyresults.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 && mv '$oaccuracyresults.files_path/index.html' '$oaccuracyresults';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 cp omazscores.qza $omazscores;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 qiime tools export --input-path oclustermap.qzv --output-path out && mkdir -p '$oclustermap.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 && cp -r out/* '$oclustermap.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 && mv '$oclustermap.files_path/index.html' '$oclustermap';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 qiime tools export --input-path ovolatilityplots.qzv --output-path out && mkdir -p '$ovolatilityplots.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 && cp -r out/* '$ovolatilityplots.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 && mv '$ovolatilityplots.files_path/index.html' '$ovolatilityplots'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 <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
110 <param label="--p-state-column: TEXT Numeric metadata column containing sampling time (state) data to use as prediction target. [required]" name="pstatecolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 <param label="--p-group-by: TEXT Categorical metadata column to use for plotting and significance testing between main treatment groups. [required]" name="pgroupby" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 <param label="--p-control: TEXT Value of group-by to use as control group. The regression model will be trained using only control group data, and the maturity scores of other groups consequently will be assessed relative to this group. [required]" name="pcontrol" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 <param label="--p-individual-id-column: TEXT Optional metadata column containing IDs for individual subjects. Adds individual subject (spaghetti) vectors to volatility charts if a column name is provided. [optional]" name="pindividualidcolumn" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 <param label="--p-estimator: " name="pestimator" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 <option value="RandomForestRegressor">RandomForestRegressor</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 <option value="ExtraTreesRegressor">ExtraTreesRegressor</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 <option value="GradientBoostingRegressor">GradientBoostingRegressor</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 <option value="AdaBoostRegressor">AdaBoostRegressor</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 <option value="ElasticNet">ElasticNet</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 <option value="Ridge">Ridge</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 <option value="Lasso">Lasso</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 <option value="KNeighborsRegressor">KNeighborsRegressor</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 <option value="LinearSVR">LinearSVR</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 <option value="SVR">SVR</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 <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" min="1" value="100"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 <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.5]" name="ptestsize" optional="True" type="float" exclusive_start="True" min="0" max="1" value="0.5"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 <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" exclusive_start="True" min="0" max="1" value="0.05"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 <param label="--p-cv: INTEGER Number of k-fold cross-validations to perform. Range(1, None) [default: 5]" name="pcv" optional="True" type="integer" min="1" value="5"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 <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
132 <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
133 <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
134 <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" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 <param label="--p-missing-samples: " name="pmissingsamples" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 <option value="error">error</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138 <option value="ignore">ignore</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140 <param label="--p-feature-count: INTEGER Range(0, None) Filter feature table to include top N most important features. Set to zero to include all features. [default: 50]" name="pfeaturecount" optional="True" type="integer" min="0" value="50"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
143 <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
144 </repeat> </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
145
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
146 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
147 <data format="qza" label="${tool.name} on ${on_string}: sampleestimator.qza" name="osampleestimator"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
148 <data format="qza" label="${tool.name} on ${on_string}: featureimportance.qza" name="ofeatureimportance"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
149 <data format="qza" label="${tool.name} on ${on_string}: predictions.qza" name="opredictions"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
150 <data format="html" label="${tool.name} on ${on_string}: modelsummary.qzv" name="omodelsummary"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
151 <data format="html" label="${tool.name} on ${on_string}: accuracyresults.qzv" name="oaccuracyresults"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
152 <data format="qza" label="${tool.name} on ${on_string}: mazscores.qza" name="omazscores"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
153 <data format="html" label="${tool.name} on ${on_string}: clustermap.qzv" name="oclustermap"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
154 <data format="html" label="${tool.name} on ${on_string}: volatilityplots.qzv" name="ovolatilityplots"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
155 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
156 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
157 Microbial maturity index prediction.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
158 ####################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
159
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
160 Calculates a "microbial maturity" index from a regression model trained on
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
161 feature data to predict a given continuous metadata column, e.g., to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
162 predict age as a function of microbiota composition. The model is trained
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
163 on a subset of control group samples, then predicts the column value for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
164 all samples. This visualization computes maturity index z-scores to compare
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
165 relative "maturity" between each group, as described in
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
166 doi:10.1038/nature13421. This method can be used to predict between-group
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
167 differences in relative trajectory across any type of continuous metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
168 gradient, e.g., intestinal microbiome development by age, microbial
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
169 succession during wine fermentation, or microbial community differences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
170 along environmental gradients, as a function of two or more different
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
171 "treatment" groups.
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 : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
179 \
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
180 state_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
181 Numeric metadata column containing sampling time (state) data to use as
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
182 prediction target.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
183 group_by : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
184 Categorical metadata column to use for plotting and significance
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
185 testing between main treatment groups.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
186 control : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
187 Value of group_by to use as control group. The regression model will be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
188 trained using only control group data, and the maturity scores of other
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
189 groups consequently will be assessed relative to this group.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
190 individual_id_column : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
191 Optional metadata column containing IDs for individual subjects. Adds
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
192 individual subject (spaghetti) vectors to volatility charts if a column
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
193 name is provided.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
194 estimator : Str % Choices('RandomForestRegressor', 'ExtraTreesRegressor', 'GradientBoostingRegressor', 'AdaBoostRegressor', 'ElasticNet', 'Ridge', 'Lasso', 'KNeighborsRegressor', 'LinearSVR', 'SVR'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
195 Regression model to use for prediction.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
196 n_estimators : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
197 Number of trees to grow for estimation. More trees will improve
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
198 predictive accuracy up to a threshold level, but will also increase
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
199 time and memory requirements. This parameter only affects ensemble
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
200 estimators, such as Random Forest, AdaBoost, ExtraTrees, and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
201 GradientBoosting.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
202 test_size : Float % Range(0.0, 1.0, inclusive_start=False), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
203 Fraction of input samples to exclude from training set and use for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
204 classifier testing.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
205 step : Float % Range(0.0, 1.0, inclusive_start=False), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
206 If optimize_feature_selection is True, step is the percentage of
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
207 features to remove at each iteration.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
208 cv : Int % Range(1, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
209 Number of k-fold cross-validations to perform.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
210 random_state : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
211 Seed used by random number generator.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
212 parameter_tuning : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
213 Automatically tune hyperparameters using random grid search.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
214 optimize_feature_selection : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
215 Automatically optimize input feature selection using recursive feature
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
216 elimination.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
217 stratify : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
218 Evenly stratify training and test data among metadata categories. If
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
219 True, all values in column must match at least two samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
220 missing_samples : Str % Choices('error', 'ignore'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
221 How to handle missing samples in metadata. "error" will fail if missing
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
222 samples are detected. "ignore" will cause the feature table and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
223 metadata to be filtered, so that only samples found in both files are
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
224 retained.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
225 feature_count : Int % Range(0, None), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
226 Filter feature table to include top N most important features. Set to
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
227 zero to include all features.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
228
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
229 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
230 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
231 sample_estimator : SampleEstimator[Regressor]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
232 Trained sample estimator.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
233 feature_importance : FeatureData[Importance]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
234 Importance of each input feature to model accuracy.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
235 predictions : SampleData[RegressorPredictions]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
236 Predicted target values for each input sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
237 model_summary : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
238 Summarized parameter and (if enabled) feature selection information for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
239 the trained estimator.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
240 accuracy_results : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
241 Accuracy results visualization.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
242 maz_scores : SampleData[RegressorPredictions]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
243 Microbiota-for-age z-score predictions.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
244 clustermap : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
245 Heatmap of important feature abundance at each time point in each
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
246 group.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
247 volatility_plots : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
248 Interactive volatility plots of MAZ and maturity scores, target
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
249 (column) predictions, and the sample metadata.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
250 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
251 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
252 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
253 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
254 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
255 </tool>