annotate bedtools-galaxy/bamToBed.xml @ 0:26c21c634c51

Uploaded
author aaronquinlan
date Thu, 29 Dec 2011 10:20:07 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
1 <tool id="bedtools_bamtobed" name="Convert from BAM to BED" version="0.1.0">
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
2
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
3 <description>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
4 </description>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
5
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
6 <requirements>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
7 <requirement type="binary">bamToBed</requirement>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
8 </requirements>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
9
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
10 <command>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
11 bamToBed $option $ed_score -i '$input' &gt; '$output'
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
12 #if str($tag):
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
13 -tag $tag
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
14 #end if
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
15 </command>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
16
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
17 <inputs>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
18 <param format="bam" name="input" type="data" label="Convert the following BAM file to BED"/>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
19 <param name="option" type="select" label="What type of BED output would you like">
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
20 <option value="">Create a 6-column BED file.</option>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
21 <option value="-bed12">Create a full, 12-column "blocked" BED file.</option>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
22 <option value="-bedpe">Create a paired-end, BEDPE format.</option>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
23 </param>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
24 <param name="split" type="boolean" label="Report spliced BAM alignments as separate BED entries" truevalue="-split" falsevalue="" checked="false"/>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
25 <param name="ed_score" type="boolean" label="Use alignment's edit-distance for BED score" truevalue="-ed" falsevalue="" checked="false"/>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
26 <param name="tag" type="text" optional="true" label="Use other NUMERIC BAM alignment tag as the BED score"/>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
27 </inputs>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
28
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
29 <outputs>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
30 <data format="bed" name="output" metadata_source="input" label="${input.name} (as BED)"/>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
31 </outputs>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
32
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
33 <help>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
34
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
35 **What it does**
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
36
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
37 This tool converts a BAM file to a BED file. The end coordinate is computed
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
38 by inspecting the CIGAR string. The QNAME for the alignment is used as the
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
39 BED name field and, by default, the MAPQ is used as the BED score.
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
40
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
41 .. class:: infomark
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
42
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
43 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.
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
44
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
45
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
46 .. class:: warningmark
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
47
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
48 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).
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
49
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
50 .. class:: warningmark
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
51
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
52 If creating a BEDPE output (see output formatting options), the BAM file should be sorted by query name.
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
53
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
54 .. class:: warningmark
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
55
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
56 This tool requires that `bedtools`__ has been installed on your system.
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
57
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
58 ------
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
59
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
60 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.`__
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
61
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
62 .. __: http://code.google.com/p/bedtools/
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
63 .. __: http://code.google.com/p/bedtools/
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
64 .. __: http://cphg.virginia.edu/quinlan/
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
65 .. __: http://bioinformatics.oxfordjournals.org/content/26/6/841.short
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
66
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
67
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
68
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
69 </help>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
70 </tool>