annotate bamToBed.xml @ 34:dde39ba9c031 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
author iuc
date Mon, 29 Apr 2019 05:55:48 -0400
parents 4f7a5ccd2ae9
children b28e0cfa7ba1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
1 <tool id="bedtools_bamtobed" name="bedtools BAM to BED" version="@TOOL_VERSION@">
4
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">
27
a33db97b220c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1ec398a9421f016b852fe59d46961c12321ee5c8
iuc
parents: 4
diff changeset
7 <requirement type="package" version="@SAMTOOLS_VERSION@">samtools</requirement>
4
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" />
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
10 <command><![CDATA[
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
11 #if $input.extension == 'bam' and $option == "-bedpe":
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
12 samtools sort -n '${input}' ./input &&
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
13 #else
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
14 ln -s '${input}' ./input.bam &&
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
15 #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
16
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
17 bedtools bamtobed
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
18 $option
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
19 $ed_score
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
20 $split
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
21 #if $tag and str($tag).strip():
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
22 -tag '${tag}'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
23 #end if
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
24 -i ./input.bam
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
25 > '${output}'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
26 ]]></command>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
27 <inputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
28 <param name="input" type="data" format="bam" label="Convert the following BAM file to BED"/>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
29 <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
30 <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
31 <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
32 <option value="-bedpe">Create a paired-end, BEDPE format</option>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 </param>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
34 <expand macro="split" />
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
35 <param name="ed_score" argument="-ed" type="boolean" truevalue="-ed" falsevalue="" checked="false"
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
36 label="Use alignment's edit-distance for BED score" />
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
37 <param argument="-tag" type="text" optional="true"
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
38 label="Use other NUMERIC BAM alignment tag as the BED score" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
39 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
40 <outputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
41 <data name="output" format="bed" metadata_source="input" label="${input.name} (as BED)"/>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
43 <tests>
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="" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
48 <output name="output" file="bamToBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
49 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
50 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
51 <param name="input" value="srma_in3.bam" ftype="bam" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
52 <param name="option" value="" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
53 <param name="tag" value="NM" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
54 <output name="output" file="bamToBed_result2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
55 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
56 </tests>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
57 <help><![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
58 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
59
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
60 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
61
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
62 .. class:: infomark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
63
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
64 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
65 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
66 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
67 This is important for RNA-seq and structural variation experiments.
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
68
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
69
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
70 .. class:: warningmark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
71
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
72 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
73
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
74
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
75 @REFERENCES@
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
76 ]]></help>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
77 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
78 </tool>