1
|
1 <?xml version="1.0" encoding="UTF-8" ?>
|
2
|
2 <tool id="mda_advanced_heatmap_gen" name="Advanced NG-CHM Generator" version="2.3">
|
|
3 <requirements>
|
|
4 <requirement type="package" version="3.4.1">r-base</requirement>
|
|
5 </requirements>
|
|
6 <description> Create Clustered Heat Maps with Advanced Options</description>
|
|
7 <command interpreter="bash" detect_errors="aggressive">$__tool_directory__/heatmap_advanced.sh 'advanced' 'Heat_Map_$hmname' '$hmdesc' '$inputmatrix' ${d_rows.rowOrderMethod} ${d_rows.rowDistanceMeasure} ${d_rows.rowAgglomerationMethod} ${d_cols.columnOrderMethod} ${d_cols.columnDistanceMeasure} ${d_cols.columnAgglomerationMethod} $summarymethod '$__tool_directory__;$__tool_data_path__' ${d_rows.rowDendroCut} ${d_cols.colDendroCut} $rowDataType $colDataType 'c_${d_rows.rcutrows.rowDendroTreeCut}' 'c_${d_cols.ccutrows.colDendroTreeCut}' 't_$rowTopItems' 't_$colTopItems'
|
1
|
8
|
|
9 "
|
|
10 #for $attr in $hm_attribute
|
|
11 ${attr.attrbute_key}:${attr.attrbute_value};
|
|
12 #end for
|
|
13 "
|
|
14
|
|
15 #for $op in $operations
|
|
16 ${op.class_name}
|
|
17 ${op.repeatinput.file_name}
|
|
18 ${op.cattype.cat}
|
|
19 ${op.cattype.bartype}
|
|
20 #end for
|
|
21 '$output'
|
|
22 </command>
|
|
23 <stdio>
|
|
24 <exit_code range="1:" level="fatal" />
|
|
25 </stdio>
|
|
26 <inputs>
|
|
27 <param name="inputmatrix" type="data" format="Tabular" label="Input Data Matrix" help="Tab delimited text file with row labels, column labels, and data."/>
|
2
|
28 <param name="hmname" size="40" type="text" value="Heat_Map_name" label="Heat Map Name" help="Short Name for heat map (no spaces)."/>
|
|
29 <sanitizer>
|
|
30 <valid>
|
|
31 <add preset="string.printable"/>
|
|
32 <remove value="""/>
|
|
33 <remove value="'"/>
|
|
34 <remove value=" "/>
|
|
35 </valid>
|
|
36 </sanitizer>
|
1
|
37 <param name="hmdesc" size="100" optional="true" type="text" value="Heat_Map_description" label="Heat Map Description" help="Longer description of the heat map contents."/>
|
2
|
38 <sanitizer>
|
|
39 <valid>
|
|
40 <add preset="string.printable"/>
|
|
41 <remove value="""/>
|
|
42 <remove value="'"/>
|
|
43 <remove value=" "/>
|
|
44 </valid>
|
|
45 </sanitizer>
|
1
|
46 <param name="summarymethod" type="select" label="Data Summarization Method" help="For large matrices, the selected method is used to aggregate data values in the summary view.">
|
|
47 <option value="average">Average</option>
|
|
48 <option value="sample">Sample</option>
|
|
49 <option value="mode">Mode</option>
|
|
50 </param>
|
|
51 <conditional name="d_rows">
|
|
52 <param name="rowOrderMethod" type="select" label="Row ordering method" help="Determine if rows should be clustered, randomized, or remain as is.">
|
|
53 <option value="Hierarchical">Hierarchical Clustering</option>
|
|
54 <option value="Original">Original Order</option>
|
|
55 <option value="Random">Random</option>
|
|
56 </param>
|
|
57 <when value="Hierarchical">
|
|
58 <param name="rowDistanceMeasure" type="select" label="Row Distance Metric" help="For clustering, select the method of determining distance between rows.">
|
|
59 <option value="euclidean">Euclidean</option>
|
|
60 <option value="binary">Binary</option>
|
|
61 <option value="manhattan">Manhattan</option>
|
|
62 <option value="maximum">Maximum</option>
|
|
63 <option value="canberra">Canberra</option>
|
|
64 <option value="minkowski">Minkowski</option>
|
|
65 <option value="correlation">Correlation</option>
|
|
66 </param>
|
|
67 <param name="rowAgglomerationMethod" type="select" label="Row Clustering Method" help="For clustering, select algorithm for building clusters.">
|
|
68 <option value="average">Average Linkage</option>
|
|
69 <option value="complete">Complete Linkage</option>
|
|
70 <option value="single">Single Linkage</option>
|
|
71 <option value="ward" selected="true">Ward</option>
|
|
72 <option value="mcquitty">Mcquitty</option>
|
|
73 <option value="median">Median</option>
|
|
74 <option value="centroid">Centroid</option>
|
|
75 </param>
|
|
76 <param name="rowDendroCut" type="select" label="Row Cluster Covariate Bar" help="To generate a row covariate bar based on clusters, select the number of clusters(classes) to use.">
|
|
77 <option value="0" selected="true" >None</option>
|
|
78 <option value="2" >2</option>
|
|
79 <option value="3" >3</option>
|
|
80 <option value="4" >4</option>
|
|
81 <option value="5" >5</option>
|
|
82 <option value="6" >6</option>
|
|
83 <option value="7" >7</option>
|
|
84 <option value="8" >8</option>
|
|
85 <option value="9" >9</option>
|
|
86 <option value="10" >10</option>
|
|
87 </param>
|
|
88 <conditional name="rcutrows">
|
|
89 <param name="raddcuts" type="select" label="Add row gap(s)" help="To separate portions of the heat map with gaps, select a gap method.">
|
|
90 <option value="none">None</option>
|
|
91 <option value="treecuts">Cluster-Based Gaps</option>
|
|
92 <option value="positional">Fixed Gaps</option>
|
|
93 </param>
|
|
94 <when value="none">
|
|
95 <param name="rowDendroTreeCut" type="text" size="0" hidden="true" value="0"/>
|
|
96 </when>
|
|
97 <when value="treecuts">
|
|
98 <param name="rowDendroTreeCut" type="select" label="Cluster-Based Gap" help="Gaps will be placed between clusters. Select the number of clusters." >
|
|
99 <option value="0t" selected="true" >None</option>
|
|
100 <option value="2t" >2</option>
|
|
101 <option value="3t" >3</option>
|
|
102 <option value="4t" >4</option>
|
|
103 <option value="5t" >5</option>
|
|
104 <option value="6t" >6</option>
|
|
105 <option value="7t" >7</option>
|
|
106 <option value="8t" >8</option>
|
|
107 <option value="9t" >9</option>
|
|
108 <option value="10t" >10</option>
|
|
109 </param>
|
|
110 </when>
|
|
111 <when value="positional">
|
|
112 <param name="rowDendroTreeCut" type="text" size="100" value="None" label="Fixed Gap Location(s)" help="Enter a comma delimited list of row numbers where gaps should be created."/>
|
|
113 </when>
|
|
114 </conditional>
|
|
115 </when>
|
|
116 <when value="Original">
|
|
117 <param name="rowDistanceMeasure" type="text" size="0" hidden="true" value="n/a"/>
|
|
118 <param name="rowAgglomerationMethod" type="text" size="0" hidden="true" value="n/a"/>
|
|
119 <param name="rowDendroCut" type="text" size="0" hidden="true" value="0"/>
|
|
120 <conditional name="rcutrows">
|
|
121 <param name="raddcuts" type="select" label="Add row gap(s)" help="To separate portions of the heat map with gaps, select a gap method.">
|
|
122 <option value="none">None</option>
|
|
123 <option value="positional">Fixed Gaps</option>
|
|
124 </param>
|
|
125 <when value="none">
|
|
126 <param name="rowDendroTreeCut" type="text" size="100" value="None" hidden="true"/>
|
|
127 </when>
|
|
128 <when value="positional">
|
|
129 <param name="rowDendroTreeCut" type="text" size="100" value="None" label="Fixed Gap Location(s)" help="Enter a comma delimited list of row numbers where gaps should be created."/>
|
|
130 </when>
|
|
131 </conditional>
|
|
132 </when>
|
|
133 <when value="Random">
|
|
134 <param name="rowDistanceMeasure" type="text" size="0" hidden="true" value="n/a"/>
|
|
135 <param name="rowAgglomerationMethod" type="text" size="0" hidden="true" value="n/a"/>
|
|
136 <param name="rowDendroCut" type="text" size="0" hidden="true" value="0"/>
|
|
137 <conditional name="rcutrows">
|
|
138 <param name="raddcuts" type="select" label="Add row gap(s)" help="To separate portions of the heat map with gaps, select a gap method.">
|
|
139 <option value="none">None</option>
|
|
140 <option value="positional">Fixed Gaps</option>
|
|
141 </param>
|
|
142 <when value="none">
|
|
143 <param name="rowDendroTreeCut" type="text" size="100" value="None" hidden="true"/>
|
|
144 </when>
|
|
145 <when value="positional">
|
|
146 <param name="rowDendroTreeCut" type="text" size="100" value="None" label="Fixed Gap Location(s)" help="Enter a comma delimited list of row numbers where gaps should be created."/>
|
|
147 </when>
|
|
148 </conditional>
|
|
149 </when>
|
|
150 </conditional>
|
|
151 <param name="rowTopItems" size="100" type="text" value="None" label="Row Top Items" help="A few rows can be labeled in the full summary heat map. To do so provide a comma delimited list of row labels."/>
|
|
152 <param name="rowDataType" type="select" label="Row Label Type" help="Enable label driven link-outs by specifying the type of row labels.">
|
|
153 <option value="labels" selected="true" >None</option>
|
|
154 <option value="bio.probe.affymetrix" >Affymetrix Probe Id</option>
|
|
155 <option value="bio.feature.agilent" >Agilent Id</option>
|
|
156 <option value="bio.sample.cbioportal" >cBioPortal sample Id</option>
|
|
157 <option value="bio.transcript.ensemble" >Ensemble transcript Id</option>
|
|
158 <option value="bio.gene.entrez" >Gene Entrez Id</option>
|
|
159 <option value="bio.gene.hugo" >Gene HUGO symbol</option>
|
|
160 <option value="bio.go" >Gene Ontology (GO) Id</option>
|
|
161 <option value="bio.geo.acc" >GEO Accession Id</option>
|
|
162 <option value="bio.probe.illumina" >Illumina Probe Id</option>
|
|
163 <option value="bio.probe.infinium" >Infinium Probe Id</option>
|
|
164 <option value="bio.pathway.mdanderson" >MD Anderson pathway Id</option>
|
|
165 <option value="bio.mirna" >miRNA Id</option>
|
|
166 <option value="bio.mirna.mimat" >miRNA MIMAT Id</option>
|
|
167 <option value="bio.pubmed" >Pubmed Id</option>
|
|
168 <option value="bio.pubmed.search" >Pubmed Search Term</option>
|
|
169 <option value="scholar" >Scholarly term</option>
|
|
170 <option value="bio.gene.unigene" >Unigene CId</option>
|
|
171 <option value="bio.protein.uniprot" >UniProt Id</option>
|
|
172 </param>
|
|
173 <conditional name="d_cols">
|
|
174 <param name="columnOrderMethod" type="select" label="Column ordering method" help="Determine if columns should be clustered, randomized, or remain as is.">
|
|
175 <option value="Hierarchical">Hierarchical Clustering</option>
|
|
176 <option value="Original">Original Order</option>
|
|
177 <option value="Random">Random</option>
|
|
178 </param>
|
|
179 <when value="Hierarchical">
|
|
180 <param name="columnDistanceMeasure" type="select" label="Column Distance Metric" help="For clustering, select the method of determining distance between columns.">
|
|
181 <option value="euclidean">Euclidean</option>
|
|
182 <option value="binary">Binary</option>
|
|
183 <option value="manhattan">Manhattan</option>
|
|
184 <option value="maximum">Maximum</option>
|
|
185 <option value="canberra">Canberra</option>
|
|
186 <option value="minkowski">Minkowski</option>
|
|
187 <option value="correlation">Correlation</option>
|
|
188 </param>
|
|
189 <param name="columnAgglomerationMethod" type="select" label="Column Clustering Method" help="For clustering, select algorithm for building clusters.">
|
|
190 <option value="average">Average Linkage</option>
|
|
191 <option value="complete">Complete Linkage</option>
|
|
192 <option value="single">Single Linkage</option>
|
|
193 <option value="ward" selected="true">Ward</option>
|
|
194 <option value="mcquitty">Mcquitty</option>
|
|
195 <option value="median">Median</option>
|
|
196 <option value="centroid">Centroid</option>
|
|
197 </param>
|
|
198 <param name="colDendroCut" type="select" label="Column Cluster Covariate Bar" help="To generate a column covariate bar based on clusters, select the number of clusters(classes) to use.">
|
|
199 <option value="0" selected="true" >None</option>
|
|
200 <option value="2" >2</option>
|
|
201 <option value="3" >3</option>
|
|
202 <option value="4" >4</option>
|
|
203 <option value="5" >5</option>
|
|
204 <option value="6" >6</option>
|
|
205 <option value="7" >7</option>
|
|
206 <option value="8" >8</option>
|
|
207 <option value="9" >9</option>
|
|
208 <option value="10" >10</option>
|
|
209 </param>
|
|
210 <conditional name="ccutrows">
|
|
211 <param name="caddcuts" type="select" label="Add column gap(s)" help="To separate portions of the heat map with gaps, select a gap method.">
|
|
212 <option value="none">None</option>
|
|
213 <option value="treecuts">Cluster-Based Gaps</option>
|
|
214 <option value="positional">Fixed Gaps</option>
|
|
215 </param>
|
|
216 <when value="none">
|
|
217 <param name="colDendroTreeCut" type="text" size="0" hidden="true" value="0"/>
|
|
218 </when>
|
|
219 <when value="treecuts">
|
|
220 <param name="colDendroTreeCut" type="select" label="Cluster-Based Gap" help="Gaps will be placed between clusters. Select the number of clusters.">
|
|
221 <option value="0t" selected="true" >None</option>
|
|
222 <option value="2t" >2</option>
|
|
223 <option value="3t" >3</option>
|
|
224 <option value="4t" >4</option>
|
|
225 <option value="5t" >5</option>
|
|
226 <option value="6t" >6</option>
|
|
227 <option value="7t" >7</option>
|
|
228 <option value="8t" >8</option>
|
|
229 <option value="9t" >9</option>
|
|
230 <option value="10t" >10</option>
|
|
231 </param>
|
|
232 </when>
|
|
233 <when value="positional">
|
|
234 <param name="colDendroTreeCut" type="text" size="100" value="None" label="Fixed Gap Location(s)" help="Enter a comma delimited list of row numbers where gaps should be created."/>
|
|
235 </when>
|
|
236 </conditional>
|
|
237 </when>
|
|
238 <when value="Original">
|
|
239 <param name="columnDistanceMeasure" type="text" size="0" hidden="true" value="n/a"/>
|
|
240 <param name="columnAgglomerationMethod" type="text" size="0" hidden="true" value="n/a"/>
|
|
241 <param name="colDendroCut" type="text" size="0" hidden="true" value="0"/>
|
|
242 <conditional name="ccutrows">
|
|
243 <param name="caddcuts" type="select" label="Add column gap(s)" help="To separate portions of the heat map with gaps, select a gap method.">
|
|
244 <option value="none">None</option>
|
|
245 <option value="positional">Fixed Gaps</option>
|
|
246 </param>
|
|
247 <when value="none">
|
|
248 <param name="colDendroTreeCut" type="text" size="100" value="None" hidden="true"/>
|
|
249 </when>
|
|
250 <when value="positional">
|
|
251 <param name="colDendroTreeCut" type="text" size="100" value="None" label="Fixed Gap Location(s)" help="Enter a comma delimited list of row numbers where gaps should be created."/>
|
|
252 </when>
|
|
253 </conditional>
|
|
254 </when>
|
|
255 <when value="Random">
|
|
256 <param name="columnDistanceMeasure" type="text" size="0" hidden="true" value="n/a"/>
|
|
257 <param name="columnAgglomerationMethod" type="text" size="0" hidden="true" value="n/a"/>
|
|
258 <param name="colDendroCut" type="text" size="0" hidden="true" value="0"/>
|
|
259 <conditional name="ccutrows">
|
|
260 <param name="caddcuts" type="select" label="Add column gap(s)" help="To separate portions of the heat map with gaps, select a gap method.">
|
|
261 <option value="none">None</option>
|
|
262 <option value="positional">Fixed Gaps</option>
|
|
263 </param>
|
|
264 <when value="none">
|
|
265 <param name="colDendroTreeCut" type="text" size="100" value="None" hidden="true"/>
|
|
266 </when>
|
|
267 <when value="positional">
|
|
268 <param name="colDendroTreeCut" type="text" size="100" value="None" label="Fixed Gap Location(s)" help="Enter a comma delimited list of row numbers where gaps should be created."/>
|
|
269 </when>
|
|
270 </conditional>
|
|
271 </when>
|
|
272 </conditional>
|
|
273 <param name="colTopItems" size="100" type="text" value="None" label="Column Top Items" help="A few columns can be labeled in the full summary heat map. To do so provide a comma delimited list of column labels."/>
|
|
274 <param name="colDataType" type="select" label="Column Label Type" help="Enable label driven link-outs by specifying the type of column labels.">
|
|
275 <option value="labels" selected="true" >None</option>
|
|
276 <option value="bio.probe.affymetrix" >Affymetrix Probe Id</option>
|
|
277 <option value="bio.feature.agilent" >Agilent Id</option>
|
|
278 <option value="bio.sample.cbioportal" >cBioPortal sample Id</option>
|
|
279 <option value="bio.transcript.ensemble" >Ensemble transcript Id</option>
|
|
280 <option value="bio.gene.entrez" >Gene Entrez Id</option>
|
|
281 <option value="bio.gene.hugo" >Gene HUGO symbol</option>
|
|
282 <option value="bio.go" >Gene Ontology (GO) Id</option>
|
|
283 <option value="bio.geo.acc" >GEO Accession Id</option>
|
|
284 <option value="bio.probe.illumina" >Illumina Probe Id</option>
|
|
285 <option value="bio.probe.infinium" >Infinium Probe Id</option>
|
|
286 <option value="bio.pathway.mdanderson" >MD Anderson pathway Id</option>
|
|
287 <option value="bio.mirna" >miRNA Id</option>
|
|
288 <option value="bio.mirna.mimat" >miRNA MIMAT Id</option>
|
|
289 <option value="bio.pubmed" >Pubmed Id</option>
|
|
290 <option value="bio.pubmed.search" >Pubmed Search Term</option>
|
|
291 <option value="scholar" >Scholarly term</option>
|
|
292 <option value="bio.gene.unigene" >Unigene CId</option>
|
|
293 <option value="bio.protein.uniprot" >UniProt Id</option>
|
|
294 </param>
|
|
295 <repeat name="operations" title="Covariate Bars">
|
2
|
296 <param name="class_name" size="25" type="text" value="" label="Covariate Name" help="Covariate heat map display label.">
|
|
297 <sanitizer>
|
|
298 <valid>
|
|
299 <add preset="string.printable"/>
|
|
300 <remove value="""/>
|
|
301 <remove value="'"/>
|
|
302 <remove value=" "/>
|
1
|
303 </valid>
|
|
304 </sanitizer>
|
|
305 </param>
|
2
|
306 <param name="repeatinput" type="data" format="Tabular" label="Covariate File" help="Tab delimited text file with row or column label and covariate value on each line."/>
|
1
|
307 <conditional name="cattype">
|
|
308 <param name="cat" type="select" label="Covariate Type" help="Identify the covariate as belonging to rows or columns and containing categorical or continuous values.">
|
|
309 <option value="row_categorical" >Row Categorical</option>
|
|
310 <option value="row_continuous" >Row Continuous</option>
|
|
311 <option value="column_categorical" >Column Categorical</option>
|
|
312 <option value="column_continuous" >Column Continuous</option>
|
|
313 </param>
|
|
314 <when value="row_continuous">
|
|
315 <param name="bartype" type="select" label="Display Type">
|
|
316 <option value="color_plot" >Standard</option>
|
|
317 <option value="bar_plot" >Bar Plot</option>
|
|
318 <option value="scatter_plot" >Scatter Plot</option>
|
|
319 </param>
|
|
320 </when>
|
|
321 <when value="column_continuous">
|
|
322 <param name="bartype" type="select" label="Display Type">
|
|
323 <option value="color_plot" >Standard</option>
|
|
324 <option value="bar_plot" >Bar Plot</option>
|
|
325 <option value="scatter_plot" >Scatter Plot</option>
|
|
326 </param>
|
|
327 </when>
|
|
328 <when value="column_categorical">
|
|
329 <param name="bartype" type="text" hidden="true" value="color_plot"/>
|
|
330 </when>
|
|
331 <when value="row_categorical">
|
|
332 <param name="bartype" type="text" hidden="true" value="color_plot"/>
|
|
333 </when>
|
|
334 </conditional>
|
|
335 </repeat>
|
|
336 <repeat name="hm_attribute" title="Heat Map Attributes">
|
|
337 <param name="attrbute_key" size="50" type="text" value="" label="Heat Map Attribute Key" help="For map level attributes. Enter the key (no spaces).">
|
|
338 <sanitizer invalid_char="_">
|
|
339 <valid initial="">
|
|
340 <add preset="string.letters"/>
|
|
341 <add preset="string.digits"/>
|
|
342 </valid>
|
|
343 <mapping initial="">
|
|
344 </mapping>
|
|
345 </sanitizer>
|
|
346 </param>
|
|
347 <param name="attrbute_value" size="50" type="text" label="Heat Map Attributes Value" help="For map level attributes. Enter the value (no spaces).">
|
|
348 <sanitizer invalid_char="_">
|
|
349 <valid initial="">
|
|
350 <add preset="string.letters"/>
|
|
351 <add preset="string.digits"/>
|
|
352 </valid>
|
|
353 <mapping initial="">
|
|
354 </mapping>
|
|
355 </sanitizer>
|
|
356 </param>
|
|
357 </repeat>
|
|
358 </inputs>
|
|
359 <outputs>
|
|
360 <data name="output" label='Heat_Map_$hmname' format="ngchm"/>
|
|
361 </outputs>
|
|
362 <tests>
|
|
363 <test>
|
|
364 <param name="inputmatrix" value="400x400.txt" />
|
|
365 <param name="hmname" value="testRun" />
|
|
366 <param name="$hmdesc" value="validateTool" />
|
|
367 <param name="summarymethod" value="Average" />
|
|
368 <param name="rowOrderMethod" value="Hierarchical" />
|
|
369 <param name="rowDistanceMeasure" value="Manhattan" />
|
|
370 <param name="rowAgglomerationMethod" value="Ward" />
|
|
371 <param name="columnOrderMethod" value="Hierarchical" />
|
|
372 <param name="columnDistanceMeasure" value="Manhattan" />
|
|
373 <param name="columnAgglomerationMethod" value="Ward" />
|
|
374 <output name="output" file="Galaxy400x400-noCovariates.ngchm" lines_diff="10" />
|
|
375
|
|
376 </test>
|
|
377 <!-- galaxy/test-data/ dir where the input and output file that should match tool output will be copied -->
|
|
378 </tests>
|
|
379 </tool>
|