annotate plotCorrelation.xml @ 5:ae54e08b15d7 draft

planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
author bgruening
date Tue, 22 Dec 2015 13:45:00 -0500
parents e556e34fc12a
children 7cbaaf80dced
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
1 <tool id="deeptools_plot_correlation" name="plotCorrelation" version="@WRAPPER_VERSION@.0">
5
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
2 <description>creates a heatmap or scatterplot of correlation scores between different samples </description>
0
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
3 <macros>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
4 <token name="@BINARY@">plotCorrelation</token>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
5 <import>deepTools_macros.xml</import>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
6 </macros>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
7 <expand macro="requirements"/>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
8 <command>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
9 <![CDATA[
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
10 @BINARY@
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
11 --corData "$corData"
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
12 --plotFile "$outFileName"
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
13 --corMethod "$corMethod"
3
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
14 --whatToPlot "$plotting_type.whatToPlot"
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
15 #if str($plotting_type.whatToPlot) == 'heatmap':
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
16 @HEATMAP_OPTIONS@
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
17 #else:
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
18 --plotTitle '$plotting_type.plotTitle'
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
19 #end if
0
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
20 $skipZeros
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
21 --plotFileFormat "$outFileFormat"
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
22 $removeOutliers
3
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
23 #if $outFileCorMatrix:
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
24 --outFileCorMatrix "$matrix"
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
25 #end if
0
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
26
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
27 ]]>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
28 </command>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
29 <inputs>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
30 <param name="corData" format="deeptools_coverage_matrix" type="data" label="Matrix file from the bamCorrelate tool"/>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
31 <expand macro="corMethod" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
32
3
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
33 <conditional name="plotting_type" >
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
34 <param argument="--whatToPlot" type="select" label="Plotting type">
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
35 <option value="heatmap" selected="True">Heatmap</option>
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
36 <option value="scatterplot">Scatterplot</option>
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
37 </param>
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
38 <when value="heatmap">
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
39 <expand macro="heatmap_options" />
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
40 </when>
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
41 <when value="scatterplot">
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
42 <expand macro="plotTitle" />
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
43 </when>
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
44 </conditional>
0
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
45
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
46 <expand macro="skipZeros" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
47
3
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
48 <expand macro="input_image_file_format" />
0
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
49
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
50 <param argument="--removeOutliers" type="boolean"
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
51 truevalue="--removeOutliers" falsevalue="" label="Remove regions with very large counts"
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
52 help="If set, bins with very large counts are removed. Bins
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
53 with abnormally high reads counts artificially
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
54 increase pearson correlation; that's why, by default,
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
55 bamCorrelate tries to remove outliers using the median
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
56 absolute deviation (MAD) method applying a threshold
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
57 of 200 to only consider extremely large deviations
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
58 from the median. ENCODE blacklist page (https://sites.
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
59 google.com/site/anshulkundaje/projects/blacklists)
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
60 contains useful information about regions with
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
61 unusually high counts."/>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
62
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
63 <param name="outFileCorMatrix" type="boolean" label="Save the matrix of values underlying the heatmap"/>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
64
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
65 </inputs>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
66 <outputs>
3
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
67 <expand macro="output_image_file_format_not_nested" />
0
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
68 <data format="tabular" name="matrix" label="${tool.name} on ${on_string}: Correlation matrix">
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
69 <filter>outFileCorMatrix is True</filter>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
70 </data>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
71 </outputs>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
72 <tests>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
73 <test>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
74 <param name="corData" value="bamCorrelate_result1.npz" ftype="deeptools_coverage_matrix" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
75 <param name="outFileFormat" value="png" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
76 <param name="outFileCorMatrix" value="True" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
77 <output name="matrix" file="plotCorrelation_result1.tabular" ftype="tabular" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
78 <output name="outFileName" file="plotCorrelation_result1.png" ftype="png" compare="sim_size" delta="100" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
79 </test>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
80 <test>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
81 <param name="corData" value="bamCorrelate_result1.npz" ftype="deeptools_coverage_matrix" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
82 <param name="outFileFormat" value="png" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
83 <param name="whatToPlot" value="scatterplot" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
84 <param name="removeOutliers" value="True" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
85 <param name="plotTitle" value="Test Plot" />
3
e556e34fc12a planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit a92b8557d0985038d24daaab2996fbf8e4cd323f
bgruening
parents: 2
diff changeset
86 <output name="outFileName" file="plotCorrelation_result2.png" ftpye="png" compare="sim_size" delta="100" />
0
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
87 </test>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
88 </tests>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
89 <help>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
90 <![CDATA[
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
91 **What it does**
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
92
2
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
93 This tools takes a compressed matrix of scores (such as read coverages) for a number of genomic regions
5
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
94 and different samples. It can visualize the correlation among samples as scatterplots or as
2
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
95 heatmap of correlation coefficients. Further output files are optional.
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
96 The compressed input matrices are easily generated using the "bamCorrelate" and "bigwigCorrelate" modules of deeptools.
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
97
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
98
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
99 .. image:: $PATH_TO_IMAGES/QC_bamCorrelate_humanSamples.png
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
100 :alt: Heatmap of RNA Polymerase II ChIP-seq
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
101
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
102
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
103 You can find more details on plotCorrelation here http://deeptools.readthedocs.org/en/release-1.6/content/tools/plotCorrelation.html
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
104
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
105
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
106 **Output files**:
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
107
5
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
108 - **diagnostic plot**: Either a scatterplot or clustered heatmap (select above) displaying the values for each pair-wise correlation,
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
109 see below for an example
2
c5634baf9bf9 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
bgruening
parents: 0
diff changeset
110 - data matrix (optional): if you want to analyze or plot the correlation values using a different program, e.g. R, this matrix can be used
0
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
111
5
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
112 **Output with test dataset**:
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
113
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
114 Following is the output of plotCorrelation with our test ChIP-Seq datasets. Average coverages were computed over 10kb bins for chromosome X,
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
115 from bigwig files using bigwigCorrelate. The output was used by plotCorrelation to make a heatmap of spearman correlation between samples.
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
116
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
117 .. image:: $PATH_TO_IMAGES/plotCorrelation_galaxy_bw_heatmap_output.png
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
118
ae54e08b15d7 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 8b9cdb8dc4a8fedd2b2286e7afab6529e49a9d22-dirty
bgruening
parents: 3
diff changeset
119
0
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
120 -----
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
121
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
122 @REFERENCES@
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
123 ]]>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
124 </help>
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
125 <expand macro="citations" />
b0050909cf03 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
126 </tool>