diff galaxy-conf/IntervalStats.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/IntervalStats.xml	Mon Apr 09 11:50:23 2012 -0400
+++ b/galaxy-conf/IntervalStats.xml	Wed Apr 25 16:53:48 2012 -0400
@@ -1,7 +1,7 @@
-<tool id="IntervalStats" name="Compute window statistics" version="1.0.0">
-  <description>on data in a Wiggle file</description>
+<tool id="IntervalStats" name="Compute mean/min/max of intervals" version="1.0.0">
+  <description>of data in a Wiggle file</description>
   <command interpreter="sh">
-    galaxyToolRunner.sh ngs.IntervalStats -l $windows -o $output
+    galaxyToolRunner.sh ngs.IntervalStats -l $windows -s $stat -o $output
       #for $input in $inputs
         ${input.file}
       #end for
@@ -11,21 +11,34 @@
         <param name="file" type="data" format="bigwig,wig" />
       </repeat>
       <param format="bed,bedgraph,gff" name="windows" type="data" label="List of intervals" />
-      <!-- TODO: Implement other statistics
-      <param name="stat" type="select" optional="true" label="For each window, compute the">
+      <param name="stat" type="select" optional="true" label="For each interval, compute the">
         <option value="mean">Mean</option>
-        <option value="median">Median</option>
+        <!-- TODO <option value="median">Median</option> -->
         <option value="max">Max</option>
         <option value="min">Min</option>
-      </param> -->
+      </param>
   </inputs>
   <outputs>
       <data format="tabular" name="output" />
   </outputs>
   
 <help>
-.. class:: warningmark
+  
+This tool calculates the arithmetic mean, maximum, or minimum value for the Wig data in each interval. For each Wig file provided, an additional column is added to the output file in the order that they are added above.
+  
+.. class:: infomark
+
+**TIP:** If your dataset 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 if it was not detected correctly.
+
+-----
 
-This tool requires Wiggle/BigWig input data.
+**Example**
+
+Calculate the mean change in nucleosome occupancy for each gene in the yeast genome:
+
+- 1. Create a "change in occupancy" dataset by subtracting the normalized occupancy Wig files from your two conditions using the WigMath -> Subtract tool.
+- 2. Upload a list of intervals corresponding to the genes in the yeast genome, or pull the data from UCSC using Get Data -> UCSC Main.
+- 3. Calculate the mean change in occupancy for each gene using this tool and the datasets from (1) and (2).
+
 </help>
 </tool>