annotate bedtools-galaxy/bamToBed.xml @ 11:0ee50862dd67 default tip

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