|
10
|
1 <tool id="deeptools_heatmapper" name="heatmapper" version="1.0.2">
|
|
0
|
2 <description>creates a heatmap for a score associated to genomic regions</description>
|
|
10
|
3 <expand macro="requirements"/>
|
|
|
4 <expand macro="stdio" />
|
|
0
|
5 <macros>
|
|
|
6 <import>deepTools_macros.xml</import>
|
|
|
7 </macros>
|
|
10
|
8 <command>
|
|
|
9 heatmapper
|
|
|
10
|
|
|
11 --matrixFile $matrixFile
|
|
|
12 --outFileName $outFileName
|
|
0
|
13
|
|
10
|
14 #if $output.showOutputSettings == "yes"
|
|
|
15 --plotFileFormat $output.outFileFormat
|
|
|
16 #if $outFileNameData:
|
|
|
17 --outFileNameData '$outFileNameData'
|
|
|
18 #end if
|
|
0
|
19
|
|
10
|
20 #if $outFileNameMatrix:
|
|
|
21 --outFileNameMatrix '$outFileNameMatrix'
|
|
|
22 #end if
|
|
|
23
|
|
|
24 #if $outFileSortedRegions:
|
|
|
25 --outFileSortedRegions '$outFileSortedRegions'
|
|
|
26 #end if
|
|
|
27 #else
|
|
|
28 --plotFileFormat 'png'
|
|
|
29 #end if
|
|
|
30
|
|
|
31 #if $advancedOpt.showAdvancedOpt == "yes"
|
|
|
32 #if $advancedOpt.sortRegions:
|
|
|
33 --sortRegions '$advancedOpt.sortRegions'
|
|
|
34 #end if
|
|
0
|
35
|
|
10
|
36 #if $advancedOpt.sortUsing:
|
|
|
37 --sortUsing '$advancedOpt.sortUsing'
|
|
|
38 #end if
|
|
|
39
|
|
|
40 #if $advancedOpt.averageTypeSummaryPlot:
|
|
|
41 --averageTypeSummaryPlot '$advancedOpt.averageTypeSummaryPlot'
|
|
|
42 #end if
|
|
0
|
43
|
|
10
|
44 #if str($advancedOpt.missingDataColor.value) != "None":
|
|
|
45 --missingDataColor '$advancedOpt.missingDataColor'
|
|
|
46 #end if
|
|
|
47
|
|
|
48 --colorMap '$advancedOpt.colorMap'
|
|
|
49
|
|
|
50 #if $advancedOpt.zMin:
|
|
|
51 --zMin $advancedOpt.zMin
|
|
|
52 #end if
|
|
|
53 #if $advancedOpt.zMax:
|
|
|
54 --zMax $advancedOpt.zMax
|
|
|
55 #end if
|
|
0
|
56
|
|
10
|
57 #if $advancedOpt.yMin:
|
|
|
58 --yMin $advancedOpt.yMin
|
|
|
59 #end if
|
|
|
60 #if $advancedOpt.yMax:
|
|
|
61 --yMax $advancedOpt.yMax
|
|
|
62 #end if
|
|
0
|
63
|
|
10
|
64 --xAxisLabel '$advancedOpt.xAxisLabel'
|
|
|
65 --yAxisLabel '$advancedOpt.yAxisLabel'
|
|
|
66
|
|
|
67 --heatmapWidth $advancedOpt.heatmapWidth
|
|
|
68 --heatmapHeight $advancedOpt.heatmapHeight
|
|
|
69
|
|
|
70 --whatToShow '$advancedOpt.whatToShow'
|
|
0
|
71
|
|
10
|
72 --startLabel '$advancedOpt.startLabel'
|
|
|
73 --endLabel '$advancedOpt.endLabel'
|
|
|
74 --refPointLabel '$advancedOpt.referencePointLabel'
|
|
|
75 --regionsLabel '$advancedOpt.regionsLabel'
|
|
0
|
76
|
|
10
|
77 #if str($advancedOpt.plotTitle.value) != "None":
|
|
|
78 --plotTitle '$advancedOpt.plotTitle'
|
|
|
79 #end if
|
|
0
|
80
|
|
10
|
81 $advancedOpt.onePlotPerGroup
|
|
12
|
82
|
|
|
83 #if $advancedOpt.clustering.clustering_options == 'kmeans':
|
|
|
84 #if int($advancedOpt.clustering.k_kmeans) > 0:
|
|
|
85 --kmeans $advancedOpt.clustering.k_kmeans
|
|
|
86 #end if
|
|
|
87 #end if
|
|
|
88
|
|
10
|
89 #end if
|
|
|
90 </command>
|
|
|
91 <inputs>
|
|
|
92 <param name="matrixFile" format="bgzip" type="data" label="Matrix file from the computeMatrix tool"/>
|
|
0
|
93
|
|
11
|
94 <expand macro="graphic_output_settings">
|
|
|
95 <expand macro="input_image_file_format" />
|
|
|
96 </expand>
|
|
10
|
97
|
|
|
98 <conditional name="advancedOpt" >
|
|
|
99 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
|
|
|
100 <option value="no" selected="true">no</option>
|
|
|
101 <option value="yes">yes</option>
|
|
|
102 </param>
|
|
|
103 <when value="no" />
|
|
|
104 <when value="yes">
|
|
|
105 <param name="sortRegions" type="select" label="Sort regions"
|
|
|
106 help="Whether the heatmap should present the regions sorted. The default is to sort in descending order based on the mean value per region.">
|
|
|
107 <option value="no">no ordering</option>
|
|
|
108 <option value="descend" selected="true">descending order</option>
|
|
|
109 <option value="ascend">ascending order</option>
|
|
|
110 </param>
|
|
0
|
111
|
|
10
|
112 <param name="sortUsing" type="select" label="Method used for sorting" help="For each row the method is computed." >
|
|
|
113 <option value="mean" selected="true">mean</option>
|
|
|
114 <option value="median">median</option>
|
|
|
115 <option value="min">min</option>
|
|
|
116 <option value="max">max</option>
|
|
|
117 <option value="sum">sum</option>
|
|
|
118 <option value="region_length">region length</option>
|
|
|
119 </param>
|
|
0
|
120
|
|
10
|
121 <param name="averageTypeSummaryPlot" type="select" label="Type of statistic that should be plotted in the summary image above the heatmap">
|
|
|
122 <option value="mean" selected="true">mean</option>
|
|
|
123 <option value="median">median</option>
|
|
|
124 <option value="min">min</option>
|
|
|
125 <option value="max">max</option>
|
|
|
126 <option value="sum">sum</option>
|
|
|
127 <option value="std">std</option>
|
|
|
128 </param>
|
|
0
|
129
|
|
10
|
130 <param name="missingDataColor" type="text" label="Missing data color" value="black" optional="true" help="If 'Represent missing data as zero' is not set, such cases will be colored in black by default. By using this parameter a different color can be set. A value between 0 and 1 will be used for a gray scale (black is 0). Also color names can be used, see a list here: http://packages.python.org/ete2/reference/reference_svgcolors.html. Alternatively colors can be specified using the #rrggbb notation." />
|
|
0
|
131
|
|
10
|
132 <expand macro="colormap" />
|
|
0
|
133
|
|
10
|
134 <param name="zMin" type="float" value="" size="3" label="Minimum value for the heatmap intensities. Leave empty for automatic values" optional="true"/>
|
|
|
135 <param name="zMax" type="float" value="" size="3" label="Maximum value for the heatmap intensities. Leave empty for automatic values" optional="true"/>
|
|
|
136 <param name="yMin" type="float" value="" size="3" label="Minimum value for the Y-axis of the summary plot. Leave empty for automatic values" optional="true"/>
|
|
|
137 <param name="yMax" type="float" value="" size="3" label="Maximum value for Y-axis of the summary plot. Leave empty for automatic values" optional="true"/>
|
|
|
138
|
|
|
139 <param name="xAxisLabel" type="text" value="distance from TSS (bp)" size="200" label="Description for the x-axis label" />
|
|
|
140 <param name="yAxisLabel" type="text" value="genes" size="30" label="Description for the y-axis label for the top panel" />
|
|
0
|
141
|
|
10
|
142 <param name="heatmapWidth" type="float" value="7.5" min="1" max="100" label="Heatmap width in cm" help="The minimum value is 1 and the maximum is 100."/>
|
|
|
143 <param name="heatmapHeight" type="float" value="25" min="3" max="100" label="Heatmap height in cm" help="The minimum value is 3 and the maximum is 100."/>
|
|
0
|
144
|
|
10
|
145 <param name="whatToShow" type="select" label="What to show" help ="The default is to include a summary or profile plot on top of the heatmap and a heatmap colorbar.">
|
|
|
146 <option value="plot, heatmap and colorbar" selected="true">summary plot, heatmap and colorbar</option>
|
|
|
147 <option value="plot only">summary plot only</option>
|
|
|
148 <option value="plot and heatmap">summary plot and heatmap (no colorbar)</option>
|
|
|
149 <option value="heatmap only">heatmap only</option>
|
|
|
150 <option value="heatmap and colorbar">heatmap and colorbar</option>
|
|
|
151 <option value="colorbar only">colorbar only</option>
|
|
|
152 </param>
|
|
0
|
153
|
|
10
|
154 <param name="startLabel" type="text" value="TSS" size="10" label="Label for the region start" 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. "peak start"." />
|
|
|
155 <param name="endLabel" type="text" value="TES" size="10" label="Label for the region end" help="[only for scale-regions mode] Label shown in the plot for the region end. Default is TES (transcription end site)."/>
|
|
0
|
156
|
|
10
|
157 <param name="referencePointLabel" type="text" value="TSS" size="10" label="Reference point label" 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. "peak start" etc." />
|
|
|
158 <param name="regionsLabel" type="text" value="genes" size="30" label="Labels for the regions plotted in the heatmap" 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"."/>
|
|
|
159 <param name="plotTitle" type="text" value="" size="30" label="Title of the plot" help="Title of the plot, to be printed on top of the generated image. Leave blank for no title." />
|
|
|
160 <param name="onePlotPerGroup" type="boolean" truevalue="--onePlotPerGroup" falsevalue="" label="Do one plot per group" help="When the region file contains groups separated by "#", the default is to plot the averages for the distinct plots in one plot. If this option is set, each group will get its own plot, stacked on top of each other."/>
|
|
12
|
161
|
|
|
162 <conditional name="clustering">
|
|
|
163 <param name="clustering_options" type="select" label="Clustering algorithm">
|
|
|
164 <option value="none">No clustering</option>
|
|
|
165 <option value="kmeans">Kmeans clustering</option>
|
|
|
166 </param>
|
|
|
167 <when value="kmeans">
|
|
|
168 <param name="k_kmeans" type="integer" value="0" label="Number of clusters to compute"
|
|
|
169 help="When this option is set, then the matrix is split into clusters using the kmeans algorithm. Only works for data that is not grouped, otherwise only the first group will be clustered. If more specific clustering methods are required it is advisable to save the underlying matrix and run the clustering using other software. The plotting of the clustering may fail (Error: Segmentation fault) if a cluster has very few members compared to the total number or regions. (default: None)."/>
|
|
|
170 </when>
|
|
|
171 <when value="none" />
|
|
|
172 </conditional>
|
|
|
173
|
|
|
174
|
|
10
|
175 </when>
|
|
|
176 </conditional>
|
|
|
177 </inputs>
|
|
|
178 <outputs>
|
|
11
|
179 <expand macro="output_graphic_outputs">
|
|
|
180 <expand macro="output_image_file_format" />
|
|
|
181 </expand>
|
|
10
|
182 </outputs>
|
|
0
|
183 <tests>
|
|
|
184 <test>
|
|
|
185 <param name="matrixFile" value="master.mat.gz" ftype="bgzip" />
|
|
|
186 <output name="outFileName" file="master.png" ftype="png" compare="sim_size" delta="100" />
|
|
|
187 </test>
|
|
|
188 </tests>
|
|
10
|
189 <help>
|
|
0
|
190
|
|
|
191 **What it does**
|
|
|
192
|
|
|
193 The heatmapper visualizes scores associated with genomic regions, for example ChIP enrichment values around the TSS of genes.
|
|
|
194 Those values can be visualized individually along each of the regions provided by the user in INTERVAL or BED format.
|
|
|
195 In addition to the heatmap, an average profile plot is plotted on top of the heatmap (can be turned off by the user;
|
|
|
196 it can also be generated separately by the tool profiler).
|
|
|
197 We implemented vast optional parameters and we encourage you to play around with the min/max values displayed in the heatmap as well as
|
|
|
198 with the different coloring options. If you would like to plot heatmaps for different groups of genomic regions individually,
|
|
|
199 e.g. one plot per chromosome, simply supply each group as an individual BED file.
|
|
|
200
|
|
|
201
|
|
|
202 .. image:: $PATH_TO_IMAGES/visual_hm_DmelPolII.png
|
|
|
203 :alt: Heatmap of RNA Polymerase II ChIP-seq
|
|
|
204
|
|
|
205
|
|
|
206 -----
|
|
|
207
|
|
|
208 .. class:: infomark
|
|
|
209
|
|
|
210 @REFERENCES@
|
|
|
211
|
|
|
212 </help>
|
|
|
213 </tool>
|
