Mercurial > repos > bgruening > deeptools_plot_correlation

annotate plotCorrelation.xml @ 38:46ecfb7b7cd3 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3cefc7d64faa53ef9a4e5984c7b275fc47cbdaaf
author bgruening
date Wed, 20 Feb 2019 09:17:51 -0500
parents 659b08d0c4b1
children 7f7a2ae8a310
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
36
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
1 <tool id="deeptools_plot_correlation" name="plotCorrelation" version="@WRAPPER_VERSION@.0" profile="18.01">
27
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
2 <description>Create a heatmap or scatterplot of correlation scores between different samples </description>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
3 <macros>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
4 <token name="@BINARY@">plotCorrelation</token>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
5 <import>deepTools_macros.xml</import>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
6 </macros>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
7 <expand macro="requirements"/>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
8 <command>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
9 <![CDATA[
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
10 @BINARY@
35
bf98fa19b73a planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 5a01e3a370130f32a82d5436504371ed95be1754
bgruening
parents: 33
diff changeset
11 --corData '$corData'
bf98fa19b73a planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 5a01e3a370130f32a82d5436504371ed95be1754
bgruening
parents: 33
diff changeset
12 --plotFile '$outFileName'
bf98fa19b73a planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 5a01e3a370130f32a82d5436504371ed95be1754
bgruening
parents: 33
diff changeset
13 --corMethod '$corMethod'
bf98fa19b73a planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 5a01e3a370130f32a82d5436504371ed95be1754
bgruening
parents: 33
diff changeset
14 --whatToPlot '$plotting_type.whatToPlot'
27
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
15 #if str($plotting_type.whatToPlot) == 'heatmap':
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
16 @HEATMAP_OPTIONS@
29
b12eb8b54b45 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit b5fc4073c884a2d6a4092ea85150db1971010f28
bgruening
parents: 27
diff changeset
17 --plotWidth $plotting_type.plotWidth
b12eb8b54b45 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit b5fc4073c884a2d6a4092ea85150db1971010f28
bgruening
parents: 27
diff changeset
18 --plotHeight $plotting_type.plotHeight
27
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
19 #else:
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
20 --plotTitle '$plotting_type.plotTitle'
36
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
21 #if str($plotting_type.xRange) != '':
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
22 --xRange '$plotting_type.xRange'
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
23 #end if
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
24 #if str($plotting_type.yRange) != '':
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
25 --yRange '$plotting_type.yRange'
33
f1518335ac27 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 29
diff changeset
26 #end if
f1518335ac27 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 29
diff changeset
27 $plotting_type.log1p
27
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
28 #end if
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
29 $skipZeros
35
bf98fa19b73a planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 5a01e3a370130f32a82d5436504371ed95be1754
bgruening
parents: 33
diff changeset
30 --plotFileFormat '$outFileFormat'
27
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
31 $removeOutliers
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
32 #if $outFileCorMatrix:
35
bf98fa19b73a planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 5a01e3a370130f32a82d5436504371ed95be1754
bgruening
parents: 33
diff changeset
33 --outFileCorMatrix '$matrix'
27
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
34 #end if
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
35
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
36 ]]>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
37 </command>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
38 <inputs>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
39 <param name="corData" format="deeptools_coverage_matrix" type="data" label="Matrix file from the multiBamSummary tool"/>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
40 <expand macro="corMethod" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
41
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
42 <conditional name="plotting_type" >
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
43 <param argument="--whatToPlot" type="select" label="Plotting type">
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
44 <option value="heatmap" selected="True">Heatmap</option>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
45 <option value="scatterplot">Scatterplot</option>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
46 </param>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
47 <when value="heatmap">
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
48 <expand macro="heatmap_options" />
29
b12eb8b54b45 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit b5fc4073c884a2d6a4092ea85150db1971010f28
bgruening
parents: 27
diff changeset
49 <expand macro="plotWidthHeight" PLOTWIDTH="11.0" PLOTHEIGHT="9.5" />
27
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
50 </when>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
51 <when value="scatterplot">
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
52 <expand macro="plotTitle" />
36
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
53 <param argument="--xRange" type="text" value="" optional="true"
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
54 label="X axis range"
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
55 help="X axis range, the default scales these such that the full range of dots is displayed. The input should be two integers separated by a space." />
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
56 <param argument="--yRange" type="text" value="" optional="true"
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
57 label="Y axis range"
659b08d0c4b1 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 3024062b63fdc502b46e4f328083493c2274182a
bgruening
parents: 35
diff changeset
58 help="Y axis range, the default scales these such that the full range of dots is displayed. The input should be two integers separated by a space." />
33
f1518335ac27 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 29
diff changeset
59 <param argument="--log1p" type="boolean" truevalue="--log1p" falsevalue=""
f1518335ac27 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 29
diff changeset
60 label="Log transform"
f1518335ac27 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 29
diff changeset
61 help="Plot the natural log of the scatter plot after adding 1. Note that this is ONLY for plotting, the correlation is unaffected." />
27
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
62 </when>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
63 </conditional>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
64
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
65 <expand macro="skipZeros" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
66
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
67 <expand macro="input_image_file_format" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
68
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
69 <param argument="--removeOutliers" type="boolean"
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
70 truevalue="--removeOutliers" falsevalue="" label="Remove regions with very large counts"
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
71 help="If set, bins with very large counts are removed. Bins
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
72 with abnormally high reads counts artificially
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
73 increase pearson correlation; that's why, by default,
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
74 plotCorrelation tries to remove outliers using the median
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
75 absolute deviation (MAD) method applying a threshold
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
76 of 200 to only consider extremely large deviations
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
77 from the median. ENCODE blacklist page (https://sites.
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
78 google.com/site/anshulkundaje/projects/blacklists)
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
79 contains useful information about regions with
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
80 unusually high counts."/>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
81
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
82 <param name="outFileCorMatrix" type="boolean" label="Save the matrix of values underlying the heatmap"/>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
83
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
84 </inputs>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
85 <outputs>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
86 <expand macro="output_image_file_format_not_nested" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
87 <data format="tabular" name="matrix" label="${tool.name} on ${on_string}: Correlation matrix">
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
88 <filter>outFileCorMatrix is True</filter>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
89 </data>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
90 </outputs>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
91 <tests>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
92 <test>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
93 <param name="corData" value="multiBamSummary_result1.npz" ftype="deeptools_coverage_matrix" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
94 <param name="outFileFormat" value="png" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
95 <param name="outFileCorMatrix" value="True" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
96 <output name="matrix" file="plotCorrelation_result1.tabular" ftype="tabular" />
33
f1518335ac27 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 29
diff changeset
97 <output name="outFileName" file="plotCorrelation_result1.png" ftype="png" compare="sim_size" delta="400" />
27
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
98 </test>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
99 <test>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
100 <param name="corData" value="multiBamSummary_result1.npz" ftype="deeptools_coverage_matrix" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
101 <param name="outFileFormat" value="png" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
102 <param name="whatToPlot" value="scatterplot" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
103 <param name="removeOutliers" value="True" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
104 <param name="plotTitle" value="Test Plot" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
105 <output name="outFileName" file="plotCorrelation_result2.png" ftype="png" compare="sim_size" delta="300" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
106 </test>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
107 </tests>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
108 <help>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
109 <![CDATA[
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
110 What it does
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
111 ------------
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
112
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
113 This tools takes the default output of ``multiBamSummary`` or ``multiBigwigSummary``, and computes the pairwise correlation among samples.
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
114 Results can be visualized as **scatterplots** or as a **heatmap** of correlation coefficients (see below for examples).
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
115
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
116 Theoretical Background
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
117 ----------------------
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
118
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
119 The result of the correlation computation is a **table of correlation coefficients** that indicates how "strong" the relationship between two samples is and it will consist of numbers between -1 and 1. (-1 indicates perfect anti-correlation, 1 perfect correlation.)
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
120
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
121 We offer two different functions for the correlation computation: *Pearson* or *Spearman*.
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
122
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
123 The *Pearson method* measures the **metric differences** between samples and is therefore influenced by outliers.
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
124 The *Spearman method* is based on **rankings**.
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
125
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
126 Output
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
127 ------
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
128
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
129 The default output is a **diagnostic plot** -- either a scatterplot or a clustered heatmap displaying the values for each pair-wise correlation (see below for example plots).
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
130
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
131 Optionally, you can also obtain a table of the pairwise correlation coefficients.
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
132
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
133 .. image:: $PATH_TO_IMAGES/plotCorrelation_output.png
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
134 :width: 600
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
135 :height: 271
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
136
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
137 Example plots
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
138 -------------
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
139
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
140 The following is the output of ``plotCorrelation`` with our test ChIP-Seq datasets (to be found under "Shared Data" --> "Data Library").
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
141
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
142 Average coverages were computed over 10 kb bins for chromosome X,
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
143 from bigWig files using ``multiBigwigSummary``. This was then used with ``plotCorrelation`` to make a heatmap of Spearman correlation coefficients.
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
144
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
145 .. image:: $PATH_TO_IMAGES/plotCorrelation_galaxy_bw_heatmap_output.png
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
146 :width: 600
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
147 :height: 518
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
148
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
149 The scatterplot could look like this:
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
150
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
151 .. image:: $PATH_TO_IMAGES/plotCorrelation_scatterplot_PearsonCorr_bigwigScores.png
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
152 :width: 600
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
153 :height: 600
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
154
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
155 -----
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
156
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
157 @REFERENCES@
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
158 ]]>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
159 </help>
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
160 <expand macro="citations" />
cf1409a29f50 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 09975f870c75347fba5c6777c9f3b442bdeeb289
bgruening
parents: 24
diff changeset
161 </tool>