Mercurial > repos > bgruening > deeptools_plot_heatmap
comparison plotHeatmap.xml @ 1:6a247ae015cc draft
planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
author | bgruening |
---|---|
date | Mon, 15 Feb 2016 10:26:54 -0500 |
parents | e1bb51933e7f |
children | ca218dae7902 |
comparison
equal
deleted
inserted
replaced
0:e1bb51933e7f | 1:6a247ae015cc |
---|---|
1 <tool id="deeptools_plot_heatmap" name="plotHeatmap" version="@WRAPPER_VERSION@.0"> | 1 <tool id="deeptools_plot_heatmap" name="plotHeatmap" version="@WRAPPER_VERSION@.0"> |
2 <description>creates a heatmap for a score associated to genomic regions</description> | 2 <description>creates a heatmap for score distributions across genomic regions</description> |
3 <macros> | 3 <macros> |
4 <token name="@BINARY@">plotHeatmap</token> | 4 <token name="@BINARY@">plotHeatmap</token> |
5 <import>deepTools_macros.xml</import> | 5 <import>deepTools_macros.xml</import> |
6 </macros> | 6 </macros> |
7 <expand macro="requirements"/> | 7 <expand macro="requirements"/> |
66 | 66 |
67 --whatToShow '$advancedOpt.whatToShow' | 67 --whatToShow '$advancedOpt.whatToShow' |
68 | 68 |
69 --startLabel '$advancedOpt.startLabel' | 69 --startLabel '$advancedOpt.startLabel' |
70 --endLabel '$advancedOpt.endLabel' | 70 --endLabel '$advancedOpt.endLabel' |
71 | |
71 --refPointLabel '$advancedOpt.referencePointLabel' | 72 --refPointLabel '$advancedOpt.referencePointLabel' |
72 --regionsLabel '$advancedOpt.regionsLabel' | 73 |
74 #if $advancedOpt.samplesLabel and str($advancedOpt.samplesLabel).strip() != "": | |
75 --samplesLabel $advancedOpt.samplesLabel | |
76 #end if | |
77 | |
78 #if $advancedOpt.regionsLabel and str($advancedOpt.regionsLabel).strip() != "": | |
79 --regionsLabel $advancedOpt.regionsLabel | |
80 #end if | |
73 | 81 |
74 #if $advancedOpt.plotTitle and str($advancedOpt.plotTitle.value) != "": | 82 #if $advancedOpt.plotTitle and str($advancedOpt.plotTitle.value) != "": |
75 --plotTitle '$advancedOpt.plotTitle' | 83 --plotTitle '$advancedOpt.plotTitle' |
76 #end if | 84 #end if |
77 | 85 |
151 help="Only for scale-regions mode. Label shown in the plot for the region end. Default is TES (transcription end site)."/> | 159 help="Only for scale-regions mode. Label shown in the plot for the region end. Default is TES (transcription end site)."/> |
152 | 160 |
153 <param argument="--referencePointLabel" type="text" value="TSS" size="10" | 161 <param argument="--referencePointLabel" type="text" value="TSS" size="10" |
154 label="Reference point label" | 162 label="Reference point label" |
155 help ="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." /> | 163 help ="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." /> |
156 <param argument="--regionsLabel" type="text" value="genes" size="30" | 164 <param argument="--samplesLabel" type="text" size="30" |
157 label="Labels for the regions plotted in the heatmap" | 165 label="Labels for the samples (each bigwig) plotted" |
158 help="If more than one region is being plotted then a list of labels separated by comma is required. For example, label1, label2."> | 166 help="The default is to use the file name of the sample. The sample labels should be separated by |
167 spaces and quoted if a label itself contains a space E.g. label-1 "label 2""> | |
159 <sanitizer> | 168 <sanitizer> |
160 <valid initial="string.printable"> | 169 <valid initial="string.printable"> |
161 </valid> | 170 </valid> |
162 </sanitizer> | 171 </sanitizer> |
163 </param> | 172 </param> |
173 <param argument="--regionsLabel" type="text" size="30" | |
174 label="Labels for the regions plotted in the heatmap" | |
175 help="If more than one region is being plotted a list of labels separated by space is required. | |
176 If a label itself contains a space, then quotes are needed. | |
177 For example, label_1, "label 2"" /> | |
178 | |
164 <expand macro="plotTitle" /> | 179 <expand macro="plotTitle" /> |
165 <param argument="--perGroup" type="boolean" truevalue="--perGroup" falsevalue="" | 180 <param argument="--perGroup" type="boolean" truevalue="--perGroup" falsevalue="" |
166 label="Do one plot per group" | 181 label="Make one plot per group of regions" |
167 help="When clustering is applied to the data, or the computematrix was performed on multiple BED files, | 182 help="The default is to make one plot per bigWig file, i.e., all samples next to each other. Choosing this option will make one plot per group of regions."/> |
168 plot the groups next to each other. The default is to plot | |
169 the samples next to each other. If this option is set, each group (or cluster) will get its own plot, | |
170 with different samples stacked on top of each other."/> | |
171 | 183 |
172 <expand macro="kmeans_clustering" /> | 184 <expand macro="kmeans_clustering" /> |
173 </when> | 185 </when> |
174 </conditional> | 186 </conditional> |
175 </inputs> | 187 </inputs> |
190 <output name="outFileName" file="heatmapper_result2.png" ftype="png" compare="sim_size" delta="4000" /> | 202 <output name="outFileName" file="heatmapper_result2.png" ftype="png" compare="sim_size" delta="4000" /> |
191 </test> | 203 </test> |
192 </tests> | 204 </tests> |
193 <help> | 205 <help> |
194 <![CDATA[ | 206 <![CDATA[ |
195 **What it does** | 207 |
196 | 208 What it does |
197 The heatmapper visualizes scores associated with genomic regions, for example ChIP enrichment values around the TSS of genes. | 209 -------------- |
198 Like profiler, it requires that computeMatrix was run first to calculate the values. | 210 |
199 | 211 ``plotHeatmap`` visualizes scores associated with genomic regions, for example ChIP enrichment values around the TSS of genes. |
200 We have implemented number of optional parameters to optimize the visual output and we encourage you to play around with the min/max values | 212 Like ``plotProfile``, it requires that computeMatrix was run first to calculate the values. |
201 displayed in the heatmap as well as with the different coloring options. The most powerful option is the k-means/hierarchical clustering, | 213 |
202 where you simply need to indicate the number of groups with similar read distributions that you expect and the algorithm will do the sorting for you. | 214 We have implemented a number of optional parameters to optimize the visual output and we encourage you to play around with the min/max values |
203 | 215 displayed in the heatmap as well as with the different coloring options. |
204 | 216 |
205 .. image:: $PATH_TO_IMAGES/visual_hm_DmelPolII.png | 217 **TIP:** *If your data is rather sparse and the resulting heatmap is too black, change the "Missing data color" to white (via "Advanced options").* |
206 :alt: Heatmap of RNA Polymerase II ChIP-seq | 218 |
207 | 219 The most powerful option is probably the **k-means/hierarchical clustering** where you can sort your regions into groups of regions with similar score distributions. |
208 | 220 |
209 You can find more details on the tool on the plotHeatmap doc page: https://deeptools.readthedocs.org/en/master/content/tools/plotHeatmap.html | 221 **NOTE:** *The clustering will only work if you supplied a single BED file to computeMatrix. plotHeatmap cannot cluster regions within pre-defined groups. Moreover, k-means will be much faster than hierarchical clustering.* |
210 | 222 |
223 Output | |
224 -------------- | |
225 | |
226 This is a heatmap based on two bigWig files generated with default settings and k-means clustering. | |
227 | |
228 .. image:: $PATH_TO_IMAGES/plotHeatmap_example.png | |
229 :width: 600 | |
230 :height: 694 | |
231 | |
232 .. image:: $PATH_TO_IMAGES/plotHeatmap_example02.png | |
233 :width: 600 | |
234 :height: 694 | |
235 | |
236 In addition to the image, ``plotHeatmap`` can also generate the values underlying both the heatmap. | |
237 | |
238 See the following table for the optional output options: | |
239 | |
240 +-----------------------------------+--------------------+-----------------+-----------------+ | |
241 | **optional output type** | **computeMatrix** | **plotHeatmap** | **plotProfile** | | |
242 +-----------------------------------+--------------------+-----------------+-----------------+ | |
243 | values underlying the heatmap | yes | yes | no | | |
244 +-----------------------------------+--------------------+-----------------+-----------------+ | |
245 | values underlying the profile | no | no | yes | | |
246 +-----------------------------------+--------------------+-----------------+-----------------+ | |
247 | sorted and/or filtered regions | yes | yes | yes | | |
248 +-----------------------------------+--------------------+-----------------+-----------------+ | |
249 | |
250 **More examples** can be found in our `Gallery <http://deeptools.readthedocs.org/en/latest/content/example_gallery.html#normalized-chip-seq-signals-and-peak-regions>`_. | |
211 | 251 |
212 ----- | 252 ----- |
213 | 253 |
214 @REFERENCES@ | 254 @REFERENCES@ |
215 ]]> | 255 ]]> |