Mercurial > repos > bgruening > deeptools_plot_correlation

annotate plotCorrelation.xml @ 16:a165d1e95d7d draft

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