annotate qiime2-2020.8/qiime_longitudinal_pairwise-distances.xml @ 22:292c84bd5ab6 draft

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