diff plotCorrelation.xml @ 7:44d87fb8403e draft

planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit ae00542731230245927953207977833a0f020b69
author bgruening
date Wed, 23 Dec 2015 07:31:58 -0500
parents 7cbaaf80dced
children a48149b2cb5e
line wrap: on
line diff
--- a/plotCorrelation.xml	Wed Dec 23 03:57:45 2015 -0500
+++ b/plotCorrelation.xml	Wed Dec 23 07:31:58 2015 -0500
@@ -1,5 +1,5 @@
 <tool id="deeptools_plot_correlation" name="plotCorrelation" version="@WRAPPER_VERSION@.0">
-    <description>creates a heatmap of correlation scores between different samples </description>
+    <description>creates a heatmap or scatterplot of correlation scores between different samples </description>
     <macros>
         <token name="@BINARY@">plotCorrelation</token>
         <import>deepTools_macros.xml</import>
@@ -91,7 +91,7 @@
 **What it does**
 
 This tools takes a compressed matrix of scores (such as read coverages) for a number of genomic regions
-and different samples. It can visualize the correlation among samples as scatterplots or as 
+and different samples. It can visualize the correlation among samples as scatterplots or as
 heatmap of correlation coefficients. Further output files are optional.
 The compressed input matrices are easily generated using the "bamCorrelate" and "bigwigCorrelate" modules of deeptools.
 
@@ -105,10 +105,18 @@
 
 **Output files**:
 
-- **correlation structure**: a scatterplot of all mutual correlations between all samples in matrix
-- **diagnostic plot**: clustered heatmap displaying the values for each pair-wise correlation, see below for an example
+- **diagnostic plot**: Either a scatterplot or clustered heatmap (select above) displaying the values for each pair-wise correlation,
+  see below for an example
 - 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
 
+**Output with test dataset**:
+
+Following is the output of plotCorrelation with our test ChIP-Seq datasets. Average coverages were computed over 10kb bins for chromosome X,
+from bigwig files using bigwigCorrelate. The output was used by plotCorrelation to make a heatmap of spearman correlation between samples.
+
+.. image:: $PATH_TO_IMAGES/plotCorrelation_galaxy_bw_heatmap_output.png
+
+
 -----
 
 @REFERENCES@