annotate qiime2/qiime_longitudinal_linear-mixed-effects.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_longitudinal_linear-mixed-effects" name="qiime longitudinal linear-mixed-effects" version="2018.4">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Linear mixed effects modeling</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 longitudinal linear-mixed-effects --p-state-column="$pstatecolumn"
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) --p-individual-id-column="$pindividualidcolumn" --p-metric="$pmetric"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
20 #if str($itable) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
21 --i-table=$itable
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
22 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
23
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
24 #if str($cmdconfig) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
25 --cmd-config=$cmdconfig
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
26 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
27 --o-visualization=ovisualization
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
28 #if $pci:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
29 --p-ci=$pci
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
31
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
32 #if str($ppalette) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
33 --p-palette=$ppalette
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
35
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
36 #if str($pgroupcolumns):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
37 --p-group-columns="$pgroupcolumns"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
39
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
40 #if $plowess:
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
41 --p-lowess
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
42 #else
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
43 --p-no-lowess
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
44 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
45
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
46 #if str($prandomeffects):
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
47 --p-random-effects="$prandomeffects"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
48 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
49 ;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
50
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
51 qiime tools export ovisualization.qzv --output-dir out && mkdir -p '$ovisualization.files_path'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
52 && cp -r out/* '$ovisualization.files_path'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
53 && mv '$ovisualization.files_path/index.html' '$ovisualization'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
54 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
55 </command>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
56 <inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
57 <param format="qza,no_unzip.zip" label="--i-table: FeatureTable[RelativeFrequency] Feature table to optionally use for paired comparisons. [optional]" name="itable" optional="True" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
58
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
59 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
60 <param label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. Sample metadata file containing individual_id_column. [required]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
61 </repeat>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
62
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
63 <param label="--p-metric: Dependent variable column name. Must be a column name located in the metadata or feature table files. [required]" name="pmetric" optional="False" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
64
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
65 <param label="--p-state-column: Metadata column containing state (e.g., Time) across which samples are paired. [required]" name="pstatecolumn" optional="False" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
66
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
67 <param label="--p-individual-id-column: Metadata column containing IDs for individual subjects. [required]" name="pindividualidcolumn" optional="False" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
68 <param label="--p-group-columns: 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"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
69
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
70 <param label="--p-random-effects: 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"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
71
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
72 <param label="--p-palette: Color palette to use for generating
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
73 boxplots. [default: Set1]" name="ppalette" optional="True" type="select">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
74 <option selected="True" value="None">Selection is Optional</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
75 <option value="Accent">Accent</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
76 <option value="tab20">tab20</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
77 <option value="Pastel2">Pastel2</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
78 <option value="plasma">plasma</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
79 <option value="viridis">viridis</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
80 <option value="rainbow">rainbow</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
81 <option value="Pastel1">Pastel1</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
82 <option value="inferno">inferno</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
83 <option value="magma">magma</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
84 <option value="tab20b">tab20b</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
85 <option value="Set3">Set3</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
86 <option value="Set2">Set2</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
87 <option value="Dark2">Dark2</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
88 <option value="Set1">Set1</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
89 <option value="tab10">tab10</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
90 <option value="tab20c">tab20c</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
91 <option value="terrain">terrain</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
92 <option value="Paired">Paired</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
93 </param>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
94
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
95 <param label="--p-lowess: --p-no-lowess Estimate locally weighted scatterplot smoothing. Note that this will eliminate confidence interval plotting. [default: False]" name="plowess" checked="False" type="boolean"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
96 <param label="--p-ci: Size of the confidence interval for the regression estimate. [default: 95]" name="pci" optional="True" type="integer" value="95"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
97
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
98 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
99 </inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
100 <outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
101 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
102 </outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
103 <help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
104 <![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
105 Linear mixed effects modeling
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
106 ------------------------------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
107
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
108 Linear mixed effects models evaluate the contribution of exogenous
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
109 covariates "group_columns" and "random_effects" to a single dependent
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
110 variable, "metric". Perform LME and plot line plots of each group column. A
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
111 feature table artifact is required input, though whether "metric" is
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
112 derived from the feature table or metadata is optional.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
113
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
114 Parameters
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
115 ----------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
116 table : FeatureTable[RelativeFrequency], optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
117 Feature table to optionally use for paired comparisons.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
118 metadata : Metadata
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
119 Sample metadata file containing individual_id_column.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
120 metric : Str
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
121 Dependent variable column name. Must be a column name located in the
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
122 metadata or feature table files.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
123 state_column : Str
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
124 Metadata column containing state (e.g., Time) across which samples are
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
125 paired.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
126 individual_id_column : Str
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
127 Metadata column containing IDs for individual subjects.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
128 group_columns : Str, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
129 Comma-separated list (without spaces) of metadata columns to use as
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
130 independent covariates used to determine mean structure of "metric".
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
131 random_effects : Str, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
132 Comma-separated list (without spaces) of metadata columns to use as
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
133 independent covariates used to determine the variance and covariance
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
134 structure (random effects) of "metric". To add a random slope, the same
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
135 value passed to "state_column" should be passed here. A random
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
136 intercept for each individual is set by default and does not need to be
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
137 passed here.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
138 palette : Str % Choices({'Accent', 'Dark2', 'Paired', 'Pastel1', 'Pastel2', 'Set1', 'Set2', 'Set3', 'inferno', 'magma', 'plasma', 'rainbow', 'tab10', 'tab20', 'tab20b', 'tab20c', 'terrain', 'viridis'}), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
139 Color palette to use for generating boxplots.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
140 lowess : Bool, optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
141 Estimate locally weighted scatterplot smoothing. Note that this will
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
142 eliminate confidence interval plotting.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
143 ci : Float % Range(0, 100), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
144 Size of the confidence interval for the regression estimate.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
145
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
146 Returns
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
147 -------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
148 visualization : Visualization
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
149 \
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
150 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
151 </help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
152 <macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
153 <import>qiime_citation.xml</import>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
154 </macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
155 <expand macro="qiime_citation" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
156 </tool>