annotate qiime2/qiime_longitudinal_pairwise-differences.xml @ 14:a0a8d77a991c draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:51:29 +0000
parents f190567fe3f6
children
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" ?>
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
2 <tool id="qiime_longitudinal_pairwise-differences" name="qiime longitudinal pairwise-differences"
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
3 version="2020.8">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
4 <description>Paired difference testing and boxplots</description>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
5 <requirements>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
7 </requirements>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
8 <command><![CDATA[
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9 qiime longitudinal pairwise-differences
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
11 #if str($itable) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
12 --i-table=$itable
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
13 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
14 # if $input_files_mmetadatafile:
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
15 # def list_dict_to_string(list_dict):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
16 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
17 # for d in list_dict[1:]:
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
18 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
19 # end for
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
20 # return $file_list
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
21 # end def
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
22 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
23 # end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
24
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
25 --p-metric=$pmetric
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
26
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
27 #if '__ob__' in str($pstatecolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
28 #set $pstatecolumn_temp = $pstatecolumn.replace('__ob__', '[')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
29 #set $pstatecolumn = $pstatecolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
30 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
31 #if '__cb__' in str($pstatecolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
32 #set $pstatecolumn_temp = $pstatecolumn.replace('__cb__', ']')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
33 #set $pstatecolumn = $pstatecolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
34 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
35 #if 'X' in str($pstatecolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
36 #set $pstatecolumn_temp = $pstatecolumn.replace('X', '\\')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
37 #set $pstatecolumn = $pstatecolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
38 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
39 #if '__sq__' in str($pstatecolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
40 #set $pstatecolumn_temp = $pstatecolumn.replace('__sq__', "'")
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
41 #set $pstatecolumn = $pstatecolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
42 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
43 #if '__db__' in str($pstatecolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
44 #set $pstatecolumn_temp = $pstatecolumn.replace('__db__', '"')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
45 #set $pstatecolumn = $pstatecolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
46 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
47
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
48 --p-state-column=$pstatecolumn
4
florianbegusch
parents: 0
diff changeset
49
florianbegusch
parents: 0
diff changeset
50
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
51 --p-state-1=$pstate1
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
52
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
53 --p-state-2=$pstate2
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
54
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
55 #if '__ob__' in str($pindividualidcolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
56 #set $pindividualidcolumn_temp = $pindividualidcolumn.replace('__ob__', '[')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
57 #set $pindividualidcolumn = $pindividualidcolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
58 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
59 #if '__cb__' in str($pindividualidcolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
60 #set $pindividualidcolumn_temp = $pindividualidcolumn.replace('__cb__', ']')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
61 #set $pindividualidcolumn = $pindividualidcolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
62 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
63 #if 'X' in str($pindividualidcolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
64 #set $pindividualidcolumn_temp = $pindividualidcolumn.replace('X', '\\')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
65 #set $pindividualidcolumn = $pindividualidcolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
66 #end if
4
florianbegusch
parents: 0
diff changeset
67 #if '__sq__' in str($pindividualidcolumn):
florianbegusch
parents: 0
diff changeset
68 #set $pindividualidcolumn_temp = $pindividualidcolumn.replace('__sq__', "'")
florianbegusch
parents: 0
diff changeset
69 #set $pindividualidcolumn = $pindividualidcolumn_temp
florianbegusch
parents: 0
diff changeset
70 #end if
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
71 #if '__db__' in str($pindividualidcolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
72 #set $pindividualidcolumn_temp = $pindividualidcolumn.replace('__db__', '"')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
73 #set $pindividualidcolumn = $pindividualidcolumn_temp
4
florianbegusch
parents: 0
diff changeset
74 #end if
florianbegusch
parents: 0
diff changeset
75
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
76 --p-individual-id-column=$pindividualidcolumn
4
florianbegusch
parents: 0
diff changeset
77
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
79 #if '__ob__' in str($pgroupcolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
80 #set $pgroupcolumn_temp = $pgroupcolumn.replace('__ob__', '[')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
81 #set $pgroupcolumn = $pgroupcolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
82 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
83 #if '__cb__' in str($pgroupcolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
84 #set $pgroupcolumn_temp = $pgroupcolumn.replace('__cb__', ']')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
85 #set $pgroupcolumn = $pgroupcolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
86 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
87 #if 'X' in str($pgroupcolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
88 #set $pgroupcolumn_temp = $pgroupcolumn.replace('X', '\\')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
89 #set $pgroupcolumn = $pgroupcolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
90 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
91 #if '__sq__' in str($pgroupcolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
92 #set $pgroupcolumn_temp = $pgroupcolumn.replace('__sq__', "'")
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
93 #set $pgroupcolumn = $pgroupcolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
94 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
95 #if '__db__' in str($pgroupcolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
96 #set $pgroupcolumn_temp = $pgroupcolumn.replace('__db__', '"')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
97 #set $pgroupcolumn = $pgroupcolumn_temp
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 #if str($pgroupcolumn):
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
101 --p-group-column=$pgroupcolumn
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 #if $pparametric:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 --p-parametric
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 #if str($ppalette) != 'None':
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
109 --p-palette=$ppalette
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 #if str($preplicatehandling) != 'None':
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
113 --p-replicate-handling=$preplicatehandling
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 --o-visualization=ovisualization
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
117
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
118 #if str($examples) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
119 --examples=$examples
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
120 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
121
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 ;
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
123 cp odistancematrix.qza $odistancematrix
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
124
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
125 ;
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
126 qiime tools export ovisualization.qzv --output-path out
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
127 && mkdir -p '$ovisualization.files_path'
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 && cp -r out/* '$ovisualization.files_path'
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
129 && mv '$ovisualization.files_path/index.html' '$ovisualization'
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
131 ]]></command>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
132 <inputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
133 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[RelativeFrequency] Feature table to optionally use for paired comparisons. [optional]" name="itable" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
134 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
135 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA... (multiple Sample metadata file containing arguments will be individual-id-column. merged) [required]" name="additional_input" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
136 </repeat>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
137 <param label="--p-metric: TEXT Numerical metadata or artifact column to test. [required]" name="pmetric" optional="False" type="text" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
138 <param label="--p-state-column: TEXT Metadata column containing state (e.g., Time) across which samples are paired. [required]" name="pstatecolumn" optional="False" type="text" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
139 <param label="--p-state-1: TEXT Baseline state column value. [required]" name="pstate1" optional="False" type="text" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
140 <param label="--p-state-2: TEXT State column value to pair with baseline. [required]" name="pstate2" optional="False" type="text" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
141 <param label="--p-individual-id-column: TEXT Metadata column containing subject IDs to use for pairing samples. WARNING: if replicates exist for an individual ID at either state-1 or state-2, that subject will be dropped and reported in standard output by default. Set replicate_handling=\'random\' to instead randomly select one member. [required]" name="pindividualidcolumn" optional="False" type="text" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
142 <param label="--p-group-column: TEXT Metadata column on which to separate groups for comparison [optional]" name="pgroupcolumn" optional="False" type="text" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
143 <param label="--p-parametric: --p-parametric: / --p-no-parametric Perform parametric (ANOVA and t-tests) or non-parametric (Kruskal-Wallis, Wilcoxon, and Mann-Whitney U tests) statistical tests. [default: False]" name="pparametric" selected="False" type="boolean" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
144 <param label="--p-palette: " name="ppalette" optional="True" type="select">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
145 <option selected="True" value="None">Selection is Optional</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
146 <option value="Set1">Set1</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
147 <option value="Set2">Set2</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
148 <option value="Set3">Set3</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
149 <option value="Pastel1">Pastel1</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
150 <option value="Pastel2">Pastel2</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
151 <option value="Paired">Paired</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
152 <option value="Accent">Accent</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
153 <option value="Dark2">Dark2</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
154 <option value="tab10">tab10</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
155 <option value="tab20">tab20</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
156 <option value="tab20b">tab20b</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
157 <option value="tab20c">tab20c</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
158 <option value="viridis">viridis</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
159 <option value="plasma">plasma</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
160 <option value="inferno">inferno</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
161 <option value="magma">magma</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
162 <option value="terrain">terrain</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
163 <option value="rainbow">rainbow</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
164 <option value="cividis">cividis</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
165 </param>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
166 <param label="--p-replicate-handling: " name="preplicatehandling" optional="True" type="select">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
167 <option selected="True" value="None">Selection is Optional</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
168 <option value="error">error</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
169 <option value="random">random</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
170 <option value="drop">drop</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
171 </param>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
172 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
173
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
174 </inputs>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
175
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
176 <outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
177 <data format="html" label="${tool.name} on ${on_string}: visualization.html" name="ovisualization" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
178
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
179 </outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
180
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
181 <help><![CDATA[
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
182 Paired difference testing and boxplots
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
183 ###############################################################
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
184
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
185 Performs paired difference testing between samples from each subject.
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
186 Sample pairs may represent a typical intervention study (e.g., samples
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
187 collected pre- and post-treatment), paired samples from two different
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
188 timepoints (e.g., in a longitudinal study design), or identical samples
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
189 receiving different treatments. This action tests whether the change in a
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
190 numeric metadata value "metric" differs from zero and differs between
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
191 groups (e.g., groups of subjects receiving different treatments), and
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
192 produces boxplots of paired difference distributions for each group. Note
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
193 that "metric" can be derived from a feature table or metadata.
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
194
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
195 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
196 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
197 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
198 Sample metadata file containing individual_id_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
199 metric : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
200 Numerical metadata or artifact column to test.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
201 state_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
202 Metadata column containing state (e.g., Time) across which samples are
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
203 paired.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
204 state_1 : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
205 Baseline state column value.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
206 state_2 : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
207 State column value to pair with baseline.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
208 individual_id_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
209 Metadata column containing subject IDs to use for pairing samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
210 WARNING: if replicates exist for an individual ID at either state_1 or
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
211 state_2, that subject will be dropped and reported in standard output
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
212 by default. Set replicate_handling="random" to instead randomly select
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
213 one member.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
214 group_column : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
215 Metadata column on which to separate groups for comparison
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
216 parametric : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
217 Perform parametric (ANOVA and t-tests) or non-parametric (Kruskal-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
218 Wallis, Wilcoxon, and Mann-Whitney U tests) statistical tests.
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
219 palette : Str % Choices('Set1', 'Set2', 'Set3', 'Pastel1', 'Pastel2', 'Paired', 'Accent', 'Dark2', 'tab10', 'tab20', 'tab20b', 'tab20c', 'viridis', 'plasma', 'inferno', 'magma', 'terrain', 'rainbow', 'cividis'), optional
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
220 Color palette to use for generating boxplots.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
221 replicate_handling : Str % Choices('error', 'random', 'drop'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
222 Choose how replicate samples are handled. If replicates are detected,
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
223 "error" causes method to fail; "drop" will discard all replicated
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
224 samples; "random" chooses one representative at random from among
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
225 replicates.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
226 table : FeatureTable[RelativeFrequency], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
227 Feature table to optionally use for paired comparisons.
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 visualization : Visualization
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
232 ]]></help>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
233 <macros>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
234 <import>qiime_citation.xml</import>
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
235 </macros>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
236 <expand macro="qiime_citation"/>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
237 </tool>