annotate plotCorrelation.xml @ 0:b2886915ce68 draft default tip

Uploaded
author bgruening
date Tue, 10 Feb 2015 03:21:34 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
1 <tool id="deeptools_plotCorrelation" name="plotCorrelation" version="@WRAPPER_VERSION@.0">
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
2 <description>creates a heatmap for a score associated to genomic regions</description>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
3 <expand macro="requirements"/>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
4 <expand macro="stdio" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
5 <macros>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
6 <token name="@BINARY@">heatmapper</token>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
7 <import>deepTools_macros.xml</import>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
8 </macros>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
9 <command>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
10 <![CDATA[
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
11 heatmapper
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
12
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
13 --matrixFile $matrixFile
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
14 --outFileName $outFileName
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
15
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
16 #if $output.showOutputSettings == "yes"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
17 --plotFileFormat $output.outFileFormat
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
18 #if $outFileNameData:
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
19 --outFileNameData '$outFileNameData'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
20 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
21
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
22 #if $outFileNameMatrix:
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
23 --outFileNameMatrix '$outFileNameMatrix'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
24 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
25
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
26 #if $outFileSortedRegions:
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
27 --outFileSortedRegions '$outFileSortedRegions'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
28 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
29 #else
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
30 --plotFileFormat 'png'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
31 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
32
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
33 #if $advancedOpt.showAdvancedOpt == "yes"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
34 #if $advancedOpt.sortRegions:
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
35 --sortRegions '$advancedOpt.sortRegions'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
36 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
37
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
38 #if $advancedOpt.sortUsing:
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
39 --sortUsing '$advancedOpt.sortUsing'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
40 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
41
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
42 #if $advancedOpt.averageTypeSummaryPlot:
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
43 --averageTypeSummaryPlot '$advancedOpt.averageTypeSummaryPlot'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
44 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
45
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
46 #if str($advancedOpt.missingDataColor.value) != "None":
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
47 --missingDataColor '$advancedOpt.missingDataColor'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
48 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
49
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
50 --colorMap '$advancedOpt.colorMap'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
51
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
52 #if str($advancedOpt.zMin).strip() != "":
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
53 --zMin $advancedOpt.zMin
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
54 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
55 #if $advancedOpt.zMax:
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
56 --zMax $advancedOpt.zMax
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
57 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
58
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
59 #if str($advancedOpt.yMin).strip() != "":
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
60 --yMin $advancedOpt.yMin
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
61 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
62 #if $advancedOpt.yMax:
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
63 --yMax $advancedOpt.yMax
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
64 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
65
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
66 --xAxisLabel '$advancedOpt.xAxisLabel'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
67 --yAxisLabel '$advancedOpt.yAxisLabel'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
68
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
69 --heatmapWidth $advancedOpt.heatmapWidth
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
70 --heatmapHeight $advancedOpt.heatmapHeight
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
71
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
72 --whatToShow '$advancedOpt.whatToShow'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
73
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
74 --startLabel '$advancedOpt.startLabel'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
75 --endLabel '$advancedOpt.endLabel'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
76 --refPointLabel '$advancedOpt.referencePointLabel'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
77 --regionsLabel '$advancedOpt.regionsLabel'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
78
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
79 #if str($advancedOpt.plotTitle.value) != "None":
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
80 --plotTitle '$advancedOpt.plotTitle'
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
81 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
82
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
83 $advancedOpt.onePlotPerGroup
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
84
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
85 @KMEANS_CLUSTERING@
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
86
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
87 #end if
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
88 ]]>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
89 </command>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
90 <inputs>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
91 <param name="corData" format="bgzip" type="data" label="Matrix file from the computeMatrix tool"/>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
92
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
93 <expand macro="input_graphic_output_settings">
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
94 <expand macro="input_image_file_format" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
95 <expand macro="input_save_matrix_values" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
96 </expand>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
97
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
98 <conditional name="advancedOpt" >
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
99 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
100 <option value="no" selected="true">no</option>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
101 <option value="yes">yes</option>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
102 </param>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
103 <when value="no" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
104 <when value="yes">
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
105
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
106 <expand macro="colormap" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
107
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
108 <param name="zMin" type="float" value="" size="3"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
109 label="Minimum value for the heatmap intensities. Leave empty for automatic values"/>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
110 <param name="zMax" type="float" value="" size="3"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
111 label="Maximum value for the heatmap intensities. Leave empty for automatic values"/>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
112
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
113 <param name="plotNumbers" type="boolean" truevalue="--plotNumbers" falsevalue=""
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
114 label="Plot the correlation value"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
115 help="If set, then the correlation number is plotted on top of the heatmap. (--plotNumbers)"/>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
116
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
117
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
118
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
119
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
120 <param name="yMin" type="float" value="" size="3"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
121 label="Minimum value for the Y-axis of the summary plot. Leave empty for automatic values"/>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
122 <param name="yMax" type="float" value="" size="3"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
123 label="Maximum value for Y-axis of the summary plot. Leave empty for automatic values"/>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
124 <param name="xAxisLabel" type="text" value="distance from TSS (bp)" size="200"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
125 label="Description for the x-axis label" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
126 <param name="yAxisLabel" type="text" value="genes" size="30"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
127 label="Description for the y-axis label for the top panel" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
128
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
129 <param name="heatmapWidth" type="float" value="7.5" min="1" max="100"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
130 label="Heatmap width in cm" help="The minimum value is 1 and the maximum is 100."/>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
131 <param name="heatmapHeight" type="float" value="25" min="3" max="100"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
132 label="Heatmap height in cm" help="The minimum value is 3 and the maximum is 100."/>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
133
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
134 <param name="whatToShow" type="select" label="What to show"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
135 help ="The default is to include a summary or profile plot on top of the heatmap and a heatmap colorbar.">
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
136 <option value="plot, heatmap and colorbar" selected="true">summary plot, heatmap and colorbar</option>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
137 <option value="plot and heatmap">summary plot and heatmap (no colorbar)</option>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
138 <option value="heatmap only">heatmap only</option>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
139 <option value="heatmap and colorbar">heatmap and colorbar</option>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
140 <option value="colorbar only">colorbar only</option>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
141 </param>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
142
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
143 <param name="startLabel" type="text" value="TSS" size="10"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
144 label="Label for the region start"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
145 help ="[only for scale-regions mode] Label shown in the plot for the start of the region. Default is TSS (transcription start site), but could be changed to anything, e.g. &quot;peak start&quot;." />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
146 <param name="endLabel" type="text" value="TES" size="10"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
147 label="Label for the region end"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
148 help="[only for scale-regions mode] Label shown in the plot for the region end. Default is TES (transcription end site)."/>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
149
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
150 <param name="referencePointLabel" type="text" value="TSS" size="10"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
151 label="Reference point label"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
152 help ="[only for scale-regions mode] Label shown in the plot for the reference-point. Default is the same as the reference point selected (e.g. TSS), but could be anything, e.g. &quot;peak start&quot; etc." />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
153 <param name="regionsLabel" type="text" value="genes" size="30"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
154 label="Labels for the regions plotted in the heatmap"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
155 help="If more than one region is being plotted a list of labels separated by comma and limited by quotes, is required. For example, label1, label2.">
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
156 <sanitizer>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
157 <valid initial="string.printable">
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
158 </valid>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
159 </sanitizer>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
160 </param>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
161 <param name="plotTitle" type="text" value="" size="30"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
162 label="Title of the plot" help="Title of the plot, to be printed on top of the generated image. Leave blank for no title. (--plotTitle)" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
163 <param name="onePlotPerGroup" type="boolean" truevalue="--onePlotPerGroup" falsevalue=""
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
164 label="Do one plot per group"
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
165 help="When computeMatrix was used on more than one group of genes, the average plots for all the groups will be drawn in one panel by default. If this option is set, each group will get its own plot, stacked on top of each other."/>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
166
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
167 <expand macro="kmeans_clustering" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
168 </when>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
169 </conditional>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
170 </inputs>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
171 <outputs>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
172 <expand macro="output_image_file_format" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
173 <expand macro="output_graphic_outputs" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
174 <expand macro="output_save_matrix_values" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
175 </outputs>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
176 <tests>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
177 <test>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
178 <param name="matrixFile" value="computeMatrix_result1.gz" ftype="bgzip" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
179 <output name="outFileName" file="heatmapper_result1.png" ftype="png" compare="sim_size" delta="100" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
180 </test>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
181 </tests>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
182 <help>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
183 <![CDATA[
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
184 **What it does**
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
185
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
186 Tool for visualizing a correlation using either bamCorrelate or
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
187 bigwigCorrelate. Pearson or Spearman methods are available to compute correlation
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
188 coefficients. Results can be saved into a heat map image or as multiple
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
189 scatter plots. Further output files are optional.
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
190
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
191 -----
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
192
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
193 @REFERENCES@
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
194 ]]>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
195 </help>
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
196 <expand macro="citations" />
b2886915ce68 Uploaded
bgruening
parents:
diff changeset
197 </tool>