annotate bamToBed.xml @ 12:c782e0edc4f1 draft default tip

Uploaded
author bgruening
date Thu, 19 Jun 2014 10:12:00 -0400
parents e526617a6bb9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
c782e0edc4f1 Uploaded
bgruening
parents: 11
diff changeset
1 <tool id="bedtools_bamtobed" name="Convert from BAM to BED" version="@WRAPPER_VERSION@.0">
11
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
2 <description></description>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
3 <macros>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
4 <import>macros.xml</import>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
5 </macros>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
6 <expand macro="requirements" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
7 <expand macro="stdio" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
8 <command>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
9 bedtools bamtobed
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
10 $option
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
11 $ed_score
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
12 -i '$input'
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
13 &gt; '$output'
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
14 #if str($tag):
12
c782e0edc4f1 Uploaded
bgruening
parents: 11
diff changeset
15 -tag $tag
11
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
16 #end if
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
17 </command>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
18 <inputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
19 <param format="bam" name="input" type="data" label="Convert the following BAM file to BED"/>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
20 <param name="option" type="select" label="What type of BED output would you like">
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
21 <option value="">Create a 6-column BED file.</option>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
22 <option value="-bed12">Create a full, 12-column "blocked" BED file.</option>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
23 <option value="-bedpe">Create a paired-end, BEDPE format.</option>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
24 </param>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
25 <param name="split" type="boolean" label="Report each portion of a split BAM alignment" truevalue="-split" falsevalue="" checked="false" help="(i.e., having an 'N' CIGAR operation) as a distinct BED intervals."/>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
26 <param name="ed_score" type="boolean" label="Use alignment's edit-distance for BED score" truevalue="-ed" falsevalue="" checked="false"/>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
27 <param name="tag" type="text" optional="true" label="Use other NUMERIC BAM alignment tag as the BED score"/>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
28 </inputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
29 <outputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
30 <data format="bed" name="output" metadata_source="input" label="${input.name} (as BED)"/>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
31 </outputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
32 <help>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
33
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
34 **What it does**
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
35
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
36 bedtools bamtobed is a conversion utility that converts sequence alignments in BAM format into BED, BED12, and/or BEDPE records.
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
37
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
38 .. class:: infomark
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
39
e526617a6bb9 Uploaded
bernhardlutz
parents:
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.
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
41
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
42
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
43 .. class:: warningmark
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
44
e526617a6bb9 Uploaded
bernhardlutz
parents:
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).
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
46
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
47 .. class:: warningmark
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
48
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
49 If creating a BEDPE output (see output formatting options), the BAM file should be sorted by query name.
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
50
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
51 @REFERENCES@
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
52
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
53 </help>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
54 </tool>