annotate cluster.tools/gen.matrix.heatmap.xml @ 0:0decf3fd54bc draft

Uploaded
author peter-waltman
date Thu, 28 Feb 2013 01:45:39 -0500
parents
children 563832f48c08
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
1 <tool id="gen_matrix_heatmap" name="Generate Heatmap for Matrix" force_history_refresh="True">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
2 <command interpreter="python">gen.matrix.heatmap.py
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
3 -d ${dataset1}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
4 -i ${image_format_cond.image_format}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
5 -t ${output_treeview_format}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
6 -r ${reverse_rows}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
7
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
8 #if str($image_format_cond.image_format) == 'png':
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
9 -h $report_html
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
10 -p ${report_html.files_path}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
11 #end if
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
12 #if str($image_format_cond.image_format) == 'pdf':
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
13 -h $report_pdf
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
14 #end if
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
15 #if str($treeview_output) != 'None':
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
16 -o ${treeview_output}
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
17 #end if
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
18
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
19 </command>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
20 <inputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
21 <param format="tabular" name="dataset1" type="data" label="Data Matrix" help="Provide a tab-delimited file with data to put into a heatmap generate"/>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
22 <conditional name="image_format_cond">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
23 <param name="image_format" type="select" display='radio' label="Image format">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
24 <option value="pdf">PDF</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
25 <option value="png" selected='true' >PNG (html wrapper)</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
26 </param>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
27 </conditional>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
28 <param name="output_treeview_format" type='select' display="radio" label="Output in TreeView format as well?" help="Specify whether or not to produce files for TreeView">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
29 <option value="no">No</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
30 <option value="yes" selected='true' >Yes</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
31 </param>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
32 <param name="reverse_rows" type='select' display="radio" label="Reverse Row-order (to make consistent w\TreeView Display)?" help="Specify whether or not to reverse Row-order (to make the heatmap consistent with output from TreeView (reversed otherwise)">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
33 <option value="no" selected='true'>No</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
34 <option value="yes">Yes</option>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
35 </param>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
36 </inputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
37 <outputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
38 <data format="html" name="report_html" label="Heatmap from data matrix (HTML)">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
39 <filter>(image_format_cond['image_format']=="png")</filter>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
40 </data>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
41 <data format="pdf" name="report_pdf" label="Heatmap from data matrix (PDF)">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
42 <filter>(image_format_cond['image_format']=="pdf")</filter>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
43 </data>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
44 <data format="tgz" name="treeview_output" label="Heatmap from data matrix (tgz of TreeView files)">
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
45 <filter>(output_treeview_format)=="yes"</filter>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
46 </data>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
47 </outputs>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
48 <help>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
49 .. class:: infomark
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
50
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
51 **Generate Heatmap for Matrix** - Tool to Generate a simple heatmap for a data matrix
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
52 - The tool uses HAC, with euclidean distance. If user wants other options, we recomend using either the:
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
53
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
54 * Consensus Clustering tool
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
55 * Hierarchcical Clustering tool, OR
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
56 * Partitition Clusterint tool
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
57
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
58 **OUTPUT:**
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
59 * **Heatmap** in either PDF or PNG format
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
60 * **TreeView Files** gzip tarball file of the relevant files (OPTIONAL)
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
61
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
62 ----
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
63
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
64 **Parameters**
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
65
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
66 - **Matrix in tab-delimited format** Tab-delimited file
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
67
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
68 </help>
0decf3fd54bc Uploaded
peter-waltman
parents:
diff changeset
69 </tool>