diff galaxy-conf/BaseAlignCounts.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 9266d807ca85
children eb53be9a09f4
line wrap: on
line diff
--- a/galaxy-conf/BaseAlignCounts.xml	Mon Apr 09 11:50:23 2012 -0400
+++ b/galaxy-conf/BaseAlignCounts.xml	Wed Apr 25 16:53:48 2012 -0400
@@ -1,4 +1,4 @@
-<tool id="BaseAlignCounts" name="Map coverage" version="1.0.0">
+<tool id="BaseAlignCounts" name="Calculate coverage" version="1.0.0">
   <description>of sequencing reads</description>
   <command interpreter="sh">galaxyToolRunner.sh ngs.BaseAlignCounts -i $input -a ${chromInfo} -x $X -o $output</command>
   <inputs>
@@ -10,8 +10,29 @@
   </outputs>
   
   <help>
-    .. class:: warningmark
-    
-    This tool requires sequencing reads in SAM, BAM, or Bed format.
+        
+This tool produces a new Wig file with the number of reads/intervals overlapping each base pair. Reads can be artificially extended to match known fragment lengths. If you wish to count the number of reads starting at each base pair, set the read extension to 1. If you wish to count the number of intervals overlapping each base pair, set the extension to -1.
+
+-----
+  
+.. class:: warningmark
+
+This tool requires sequencing reads in SAM, BAM, Bed, or BedGraph format. If you are artificially extending reads, ensure that the strand is set correctly in SAM, BAM, and Bed files.
+
+.. class:: infomark
+
+If you would like to convert valued interval data (e.g. BedGraph files from microarrays) to Wig format, use the Converters -> Interval to Wig converter.
+
+.. class:: infomark
+
+**TIP:** If you are going to be using reads in SAM format for multiple analyses, it is often more efficient to first convert it into BAM format using NGS: SAM Tools -> SAM-to-BAM.
+
+-----
+
+**Syntax**
+
+- **Sequencing reads** are mapped reads from a high-throughput sequencing experiment.
+- **In silico extension:** Reads will be artificially extended from their 5' end to be this length.
+
   </help>
 </tool>