diff plotCorrelation.xml @ 2:c5634baf9bf9 draft

planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 4e5124484b42d4ffef76af4bd82a6feb67a5b829
author bgruening
date Fri, 18 Dec 2015 12:27:26 -0500
parents b0050909cf03
children e556e34fc12a
line wrap: on
line diff
--- a/plotCorrelation.xml	Fri Dec 18 08:00:49 2015 -0500
+++ b/plotCorrelation.xml	Fri Dec 18 12:27:26 2015 -0500
@@ -1,5 +1,5 @@
 <tool id="deeptools_plot_correlation" name="plotCorrelation" version="@WRAPPER_VERSION@.0">
-    <description>creates a heatmap for a score associated to genomic regions</description>
+    <description>creates a heatmap of correlation scores between different samples </description>
     <macros>
         <token name="@BINARY@">plotCorrelation</token>
         <import>deepTools_macros.xml</import>
@@ -25,8 +25,8 @@
         <expand macro="corMethod" />
 
         <param argument="--whatToPlot" type="select" label="Plotting type">
-            <option value="heatmap" selected="True">Spearman</option>
-            <option value="scatterplot">Pearson</option>
+            <option value="heatmap" selected="True">Heatmap</option>
+            <option value="scatterplot">Scatterplot</option>
         </param>
 
         <expand macro="skipZeros" />
@@ -77,10 +77,24 @@
 <![CDATA[
 **What it does**
 
-Tool for visualizing a correlation using either bamCorrelate or
-bigwigCorrelate. Pearson or Spearman methods are available to compute correlation
-coefficients. Results can be saved into a heat map image or as multiple
-scatter plots. Further output files are optional.
+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 
+heatmap of correlation coefficients. Further output files are optional.
+The compressed input matrices are easily generated using the "bamCorrelate" and "bigwigCorrelate" modules of deeptools.
+
+
+.. image:: $PATH_TO_IMAGES/QC_bamCorrelate_humanSamples.png
+   :alt: Heatmap of RNA Polymerase II ChIP-seq
+
+
+You can find more details on plotCorrelation here http://deeptools.readthedocs.org/en/release-1.6/content/tools/plotCorrelation.html
+
+
+**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
+- 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
 
 -----