annotate qiime2/qiime_longitudinal_linear-mixed-effects.xml @ 7:85b520815e85 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:53:59 -0400
parents 914fa4daf16a
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_longitudinal_linear-mixed-effects" name="qiime longitudinal linear-mixed-effects" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Linear mixed effects modeling</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 linear-mixed-effects
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --p-state-column="$pstatecolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 --p-individual-id-column="$pindividualidcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #if str($itable) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #if str($pmetric):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --p-metric="$pmetric"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #if str($pgroupcolumns):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --p-group-columns="$pgroupcolumns"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 #if str($prandomeffects):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --p-random-effects="$prandomeffects"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #if str($ppalette) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 --p-palette=$ppalette
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 #if $plowess:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 --p-lowess
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49
4
florianbegusch
parents: 0
diff changeset
50 #if str($pci):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 --p-ci=$pci
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 #if str($pformula):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 --p-formula="$pformula"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 && mv '$ovisualization.files_path/index.html' '$ovisualization';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <param label="--p-state-column: TEXT Metadata column containing state (time) variable information. [required]" name="pstatecolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <param label="--p-individual-id-column: TEXT Metadata column containing IDs for individual subjects. [required]" name="pindividualidcolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[RelativeFrequency] Feature table containing metric. [optional]" name="itable" optional="True" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 <param label="--p-metric: TEXT Dependent variable column name. Must be a column name located in the metadata or feature table files. [optional]" name="pmetric" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <param label="--p-group-columns: TEXT Comma-separated list (without spaces) of metadata columns to use as independent covariates used to determine mean structure of 'metric'. [optional]" name="pgroupcolumns" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <param label="--p-random-effects: TEXT Comma-separated list (without spaces) of metadata columns to use as independent covariates used to determine the variance and covariance structure (random effects) of 'metric'. To add a random slope, the same value passed to 'state-column' should be passed here. A random intercept for each individual is set by default and does not need to be passed here. [optional]" name="prandomeffects" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <param label="--p-palette: " name="ppalette" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <option value="Set1">Set1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <option value="Set2">Set2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <option value="Set3">Set3</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <option value="Pastel1">Pastel1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <option value="Pastel2">Pastel2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <option value="Paired">Paired</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <option value="Accent">Accent</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <option value="Dark2">Dark2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 <option value="tab10">tab10</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <option value="tab20">tab20</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <option value="tab20b">tab20b</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <option value="tab20c">tab20c</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 <option value="viridis">viridis</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 <option value="plasma">plasma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 <option value="inferno">inferno</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <option value="magma">magma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <option value="terrain">terrain</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 <option value="rainbow">rainbow</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 <param label="--p-lowess: --p-no-lowess Estimate locally weighted scatterplot smoothing. Note that this will eliminate confidence interval plotting. [default: False]" name="plowess" selected="False" type="boolean"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 <param label="--p-ci: NUMBER Size of the confidence interval for the regression Range(0, 100) estimate. [default: 95]" name="pci" optional="True" type="float" min="0" max="100" value="95"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 <param label="--p-formula: TEXT R-style formula to use for model specification. A formula must be used if the 'metric' parameter is None. Note that the metric and group columns specified in the formula will override metric and group columns that are passed separately as parameters to this method. Formulae will be in the format 'a ~ b + c', where 'a' is the metric (dependent variable) and 'b' and 'c' are independent covariates. Use '+' to add a variable; '+ a:b' to add an interaction between variables a and b; '*' to include a variable and all interactions; and '-' to subtract a particular term (e.g., an interaction term). See https://patsy.readthedocs.io/en/latest/formulas.html for full documentation of valid formula operators. Always enclose formulae in quotes to avoid unpleasant surprises. [optional]" name="pformula" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95
4
florianbegusch
parents: 0
diff changeset
96 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file [required]">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 <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
98 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 Linear mixed effects modeling
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 #############################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 Linear mixed effects models evaluate the contribution of exogenous
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 covariates "group_columns" and "random_effects" to a single dependent
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 variable, "metric". Perform LME and plot line plots of each group column. A
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 feature table artifact is required input, though whether "metric" is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 derived from the feature table or metadata is optional.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 Sample metadata file containing individual_id_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 state_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 Metadata column containing state (time) variable information.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 individual_id_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 Metadata column containing IDs for individual subjects.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 metric : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 Dependent variable column name. Must be a column name located in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 metadata or feature table files.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 group_columns : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 Comma-separated list (without spaces) of metadata columns to use as
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 independent covariates used to determine mean structure of "metric".
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 random_effects : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 Comma-separated list (without spaces) of metadata columns to use as
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 independent covariates used to determine the variance and covariance
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 structure (random effects) of "metric". To add a random slope, the same
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 value passed to "state_column" should be passed here. A random
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 intercept for each individual is set by default and does not need to be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 passed here.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 table : FeatureTable[RelativeFrequency], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 Feature table containing metric.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 palette : Str % Choices('Set1', 'Set2', 'Set3', 'Pastel1', 'Pastel2', 'Paired', 'Accent', 'Dark2', 'tab10', 'tab20', 'tab20b', 'tab20c', 'viridis', 'plasma', 'inferno', 'magma', 'terrain', 'rainbow'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138 Color palette to use for generating boxplots.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 lowess : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140 Estimate locally weighted scatterplot smoothing. Note that this will
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141 eliminate confidence interval plotting.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142 ci : Float % Range(0, 100), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
143 Size of the confidence interval for the regression estimate.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
144 formula : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
145 R-style formula to use for model specification. A formula must be used
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
146 if the "metric" parameter is None. Note that the metric and group
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
147 columns specified in the formula will override metric and group columns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
148 that are passed separately as parameters to this method. Formulae will
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
149 be in the format "a ~ b + c", where "a" is the metric (dependent
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
150 variable) and "b" and "c" are independent covariates. Use "+" to add a
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
151 variable; "+ a:b" to add an interaction between variables a and b; "*"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
152 to include a variable and all interactions; and "-" to subtract a
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
153 particular term (e.g., an interaction term). See
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
154 https://patsy.readthedocs.io/en/latest/formulas.html for full
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
155 documentation of valid formula operators. Always enclose formulae in
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
156 quotes to avoid unpleasant surprises.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
157
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
158 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
159 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
160 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
161 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
162 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
163 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
164 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
165 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
166 </tool>