annotate bamToBed.xml @ 1:82aac94b06c3 draft

Uploaded
author iuc
date Thu, 08 Jan 2015 14:25:51 -0500
parents b8348686a0b9
children 607c0576c6ab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
1 <tool id="bedtools_bamtobed" name="Convert from BAM to BED" version="@WRAPPER_VERSION@.0">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
2 <description></description>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
3 <macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
4 <import>macros.xml</import>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
5 </macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
6 <expand macro="requirements" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="stdio" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
8 <command>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
9 <![CDATA[
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
10 bedtools bamtobed
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
11 $option
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
12 $ed_score
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
13 $split
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
14 #if $tag and str($tag).strip():
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
15 -tag "${tag}"
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
16 #end if
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
17 -i "${input}"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
18 > "${output}"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
19 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
20 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
21 <inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
22 <param format="bam" name="input" type="data" label="Convert the following BAM file to BED"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
23 <param name="option" type="select" label="What type of BED output would you like">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 <option value="">Create a 6-column BED file.</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
25 <option value="-bed12">Create a full, 12-column "blocked" BED file.</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
26 <option value="-bedpe">Create a paired-end, BEDPE format.</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
27 </param>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
28 <expand macro="split" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
29 <param name="ed_score" type="boolean" truevalue="-ed" falsevalue="" checked="false"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
30 label="Use alignment's edit-distance for BED score" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
31 <param name="tag" type="text" optional="true" label="Use other NUMERIC BAM alignment tag as the BED score"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
32 help="(-tag)"/>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
34 <outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
35 <data format="bed" name="output" metadata_source="input" label="${input.name} (as BED)"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
37 <tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
38 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
39 <param name="input" value="srma_in3.bam" ftype="bam" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
40 <param name="option" value="" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
41 <param name="tag" value="" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
42 <output name="output" file="bamToBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
43 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
44 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
45 <param name="input" value="srma_in3.bam" ftype="bam" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
46 <param name="option" value="" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
47 <param name="tag" value="NM" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
48 <output name="output" file="bamToBed_result2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
49 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
50 </tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
51 <help>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
52 <![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
53 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
54
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
55 bedtools bamtobed is a conversion utility that converts sequence alignments in BAM format into BED, BED12, and/or BEDPE records.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
56
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
57 .. class:: infomark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
58
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
59 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.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
60
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
61
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
62 .. class:: warningmark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
63
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
64 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).
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
65
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
66 .. class:: warningmark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
67
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
68 If creating a BEDPE output (see output formatting options), the BAM file should be sorted by query name.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
69
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
70 @REFERENCES@
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
71 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
72 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
73 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
74 </tool>