diff bedtools-galaxy/bamToBed.xml @ 10:d72fd57eb158

Uploaded
author aaronquinlan
date Tue, 27 Dec 2011 17:05:31 -0500
parents 567af295d16e
children
line wrap: on
line diff
--- a/bedtools-galaxy/bamToBed.xml	Wed Dec 07 16:47:11 2011 -0500
+++ b/bedtools-galaxy/bamToBed.xml	Tue Dec 27 17:05:31 2011 -0500
@@ -1,5 +1,4 @@
-<tool id="bedtools_bamtobed" name="Convert from BAM to BED." version="2.14.4">
-<description></description>
+<tool id="bedtools_bamtobed" name="Convert from BAM to BED." version="0.1.0">
 
 <requirements>
     <requirement type="binary">bamToBed</requirement>
@@ -13,13 +12,13 @@
 </command>
 
 <inputs>
-    <param format="bam" name="input" type="data" label="Input BAM file"/>
-    <param name="option" type="select" label="Output formatting options">
+    <param format="bam" name="input" type="data" label="Convert the following BAM file to BED"/>
+    <param name="option" type="select" label="What type of BED output would you like">
         <option value="">Create a 6-column BED file.</option>
         <option value="-bed12">Create a full, 12-column "blocked" BED file.</option>
         <option value="-bedpe">Create a paired-end, BEDPE format.</option>
     </param>
-    <param name="split" type="boolean" label="Report spliced BAM alignments as separate BED entries." truevalue="-split" falsevalue="" checked="false"/>
+    <param name="split" type="boolean" label="Report spliced BAM alignments as separate BED entries" truevalue="-split" falsevalue="" checked="false"/>
     <param name="ed_score" type="boolean" label="Use alignment's edit-distance for BED score" truevalue="-ed" falsevalue="" checked="false"/>
     <param name="tag" type="text" optional="true" label="Use other NUMERIC BAM alignment tag as the BED score"/>
 </inputs>
@@ -34,15 +33,35 @@
 
 This tool converts a BAM file to a BED file. The end coordinate is computed
 by inspecting the CIGAR string. The QNAME for the alignment is used as the 
-BED name field and, by default, the MAPQ is used as the BED score.
+BED name field and, by default, the MAPQ is used as the BED score. 
+
+.. class:: infomark
+
+The "Report spliced BAM alignment..." option breaks BAM alignments with the "N" (splice) operator into distinct BED entries.  For example, using this option on a CIGAR such as 50M1000N50M would, by default, produce a single BED record that spans 1100bp.  However, using this option, it would create two separate BED records that are each 50bp in size and are separated by 1000bp (the size of the N operation).  This is important for RNA-seq and structural variation experiments.
+
+
+.. class:: warningmark
+
+If using a custom BAM alignment TAG as  the BED score, note that this must be a numeric tag (e.g., type "i" as in NM:i:0).
+
+.. class:: warningmark
+
+If creating a BEDPE output (see output formatting options), the BAM file should be sorted by query name.
+
+.. class:: warningmark
+
+This tool requires that `bedtools`__ has been installed on your system.
 
 ------
 
-
-This tool is part of the `BEDTools package`__ from the `Quinlan laboratory`__.
+This tool is part of the `bedtools package`__ from the `Quinlan laboratory`__. If you use this tool, please cite `Quinlan AR, and Hall I.M. BEDTools: A flexible framework for comparing genomic features. Bioinformatics, 2010, 26, 6.`__
 
-.. __: http://code.google.com/p/bedtools/
-.. __: http://cphg.virginia.edu/quinlan/
+    .. __: http://code.google.com/p/bedtools/
+    .. __: http://code.google.com/p/bedtools/
+    .. __: http://cphg.virginia.edu/quinlan/
+    .. __: http://bioinformatics.oxfordjournals.org/content/26/6/841.short
+
+
 
 </help>
 </tool>