annotate bamToBed.xml @ 16:e0cec48a4695 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ea1ac33f3337ac44f43150f585c9ccd38e08da0c
author iuc
date Fri, 18 Aug 2017 15:33:08 -0400
parents 607c0576c6ab
children a33db97b220c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
1 <tool id="bedtools_bamtobed" name="BAM to BED" version="@WRAPPER_VERSION@.0">
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
2 <description>converter</description>
0
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>
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
6 <expand macro="requirements">
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
7 <requirement type="package" version="1.2">samtools</requirement>
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
8 </expand>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
9 <expand macro="stdio" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
10 <command>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
11 <![CDATA[
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
12
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
13 #if $input.extension == 'bam' and $option == "-bedpe":
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
14 samtools sort -n "${input}" ./input &&
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
15 #else
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
16 ln -s "${input}" ./input.bam &&
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
17 #end if
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
18
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
19 bedtools bamtobed
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
20 $option
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
21 $ed_score
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
22 $split
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
23 #if $tag and str($tag).strip():
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
24 -tag "${tag}"
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
25 #end if
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
26 -i ./input.bam
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
27 > "${output}"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
28 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
29 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
30 <inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
31 <param format="bam" name="input" type="data" label="Convert the following BAM file to BED"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32 <param name="option" type="select" label="What type of BED output would you like">
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
33 <option value="">Create a 6-column BED file</option>
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
34 <option value="-bed12">Create a full, 12-column "blocked" BED file</option>
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
35 <option value="-bedpe">Create a paired-end, BEDPE format</option>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36 </param>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
37 <expand macro="split" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
38 <param name="ed_score" type="boolean" truevalue="-ed" falsevalue="" checked="false"
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
39 label="Use alignment's edit-distance for BED score" help="(-ed)" />
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
40 <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
41 help="(-tag)"/>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
43 <outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
44 <data format="bed" name="output" metadata_source="input" label="${input.name} (as BED)"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
45 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
46 <tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
47 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
48 <param name="input" value="srma_in3.bam" ftype="bam" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
49 <param name="option" value="" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
50 <param name="tag" value="" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
51 <output name="output" file="bamToBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
52 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
53 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
54 <param name="input" value="srma_in3.bam" ftype="bam" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
55 <param name="option" value="" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
56 <param name="tag" value="NM" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
57 <output name="output" file="bamToBed_result2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
58 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
59 </tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
60 <help>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
61 <![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
62 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
63
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
64 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
65
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
66 .. class:: infomark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
67
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
68 The "Report spliced BAM alignment..." option breaks BAM alignments with the "N" (splice) operator into distinct BED entries.
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
69 For example, using this option on a CIGAR such as 50M1000N50M would, by default, produce a single BED record that spans 1100bp.
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
70 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).
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
71 This is important for RNA-seq and structural variation experiments.
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
72
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
73
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
74 .. class:: warningmark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
75
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
76 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).
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
77
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
78
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
79 @REFERENCES@
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
80 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
81 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
82 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
83 </tool>