diff galaxy-conf/Autocorrelation.xml @ 12:81d5b81fb3c2 draft

Added help for all tools in the toolkit. Many bug fixes and a few new nucleosome tools.
author timpalpant
date Wed, 25 Apr 2012 16:53:48 -0400
parents 4b32ed5d4a1b
children
line wrap: on
line diff
--- a/galaxy-conf/Autocorrelation.xml	Mon Apr 09 11:50:23 2012 -0400
+++ b/galaxy-conf/Autocorrelation.xml	Wed Apr 25 16:53:48 2012 -0400
@@ -1,5 +1,5 @@
-<tool id="Autocorrelation" name="Compute the autocorrelation" version="1.0.0">
-  <description>on data in a Wiggle file</description>
+<tool id="Autocovariance" name="Compute the autocovariance" version="2.0.0">
+  <description>of data in a Wiggle file</description>
   <command interpreter="sh">galaxyToolRunner.sh ngs.Autocorrelation -i $input -l $windows -m $max -o $output</command>
   <inputs>
       <param format="bigwig,wig" name="input" type="data" label="Input data" />
@@ -11,8 +11,30 @@
   </outputs>
   
 <help>
-.. class:: warningmark
+  
+This tool computes the unnormalized autocovariance_ of intervals of data in a Wig file.
+
+.. _autocovariance: http://en.wikipedia.org/wiki/Autocorrelation
+
+-----
+
+**Syntax**
+
+- **Input data** is the genomic data on which to compute the autocorrelation.
+- **List of intervals:** The autocorrelation will be computed for each genomic interval specified in this list.
+- **Maximum shift:** In computing the autocorrelation, the data will be phase-shifted up to this limit.
 
-This tool requires Wiggle/BigWig input data.
+-----
+
+.. class:: infomark
+
+**TIP:** For more information, see Wikipedia_ (right click to open this link in another window).
+
+.. _Wikipedia: http://en.wikipedia.org/wiki/Autocorrelation
+
+.. class:: infomark
+
+**TIP:** If your input data does not appear in the pulldown menu, it means that it is not in Wig or BigWig format. Use "edit attributes" to set the correct format. Similarly, the intervals must be in either Bed, BedGraph, or GFF format.
+
 </help>
 </tool>