annotate windowBed.xml @ 12:7b3aaff0d78c draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit e5664837d1ea4575f87a9e963f5d4e18a82d51d5
author iuc
date Fri, 28 Oct 2016 12:54:40 -0400
parents 7308cc546a36
children fadebae7e69b
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_windowbed" name="WindowBed" version="@WRAPPER_VERSION@.0">
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>find overlapping intervals within a window around an interval</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>
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[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
10 bedtools window
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
11 #if $inputA.ext == "bam":
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
12 -abam '$inputA'
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
13 #else:
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
14 -a '$inputA'
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
15 #end if
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
16 -b '$inputB'
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
17 $bed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
18 $strandB
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
19 #if $addition.addition_select == 'window':
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
20 -w $addition.w
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
21 #elif $addition.addition_select == 'lr':
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
22 -l $addition.l
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
23 -r $addition.r
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 #end if
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
25 $original
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
26 $number
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
27 $nooverlaps
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
28 $header
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
29 > '$output'
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
30 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
31 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32 <inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 <param format="bed,bam,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF/BAM file"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
34 <param format="bed,gff,vcf,gff3" name="inputB" type="data" label="BED/VCF/GFF file"/>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
35 <param name="bed" type="boolean" checked="false" truevalue="-bed" falsevalue=""
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
36 label="When using BAM input, write output as BED. The default is to write output in BAM when using a bam file"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
37 help="(-bed)" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
38 <conditional name="addition">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
39 <param name="addition_select" type="select" label="Choose what you want to do">
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
40 <option value="window">Add Base pairs for **both** upstream and downstream of each entry in A when searching for overlaps in B</option>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
41 <option value="lr">Add Base pairs **separately** for upstream and downstream of each entry in A when searching for overlaps in B</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42 </param>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
43 <when value="window">
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
44 <param name="w" type="integer" value="1000" label="Base pairs to add upstream and downstream" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
45 </when>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
46 <when value="lr">
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
47 <param name="l" type="integer" value="1000"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
48 label="Base pairs added upstream (left) of each entry in A when searching for overlaps in B"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
49 help="Allows one to create assymetrical “windows”. Default is 1000bp. (-l)" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
50 <param name="r" type="integer" value="1000"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
51 label="Base pairs added downstream (right) of each entry in A when searching for overlaps in B"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
52 help="Allows one to create assymetrical “windows”. Default is 1000bp. (-r)" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
53 </when>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
54 </conditional>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
55 <param name="strandB" type="select" label="Calculation based on strandedness?">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
56 <option value="" selected="True">Report any hit in B</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
57 <option value="-sm">Only report hits in B that overlap A on the **same** strand</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
58 <option value="-Sm">Only report hits in B that overlap A on the **opposite** strand</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
59 </param>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
60 <param name="original" type="boolean" checked="false" truevalue="-u" falsevalue=""
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
61 label="Write original A entry once if any overlaps found in B"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
62 help="In other words, just report the fact at least one overlap was found in B. (-u)" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
63 <param name="number" type="boolean" checked="false" truevalue="-c" falsevalue=""
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
64 label="For each entry in A, report the number of hits in B"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
65 help="Reports 0 for A entries that have no overlap with B (-c)" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
66 <param name="nooverlaps" type="boolean" checked="false" truevalue="-v" falsevalue=""
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
67 label="Only report those entries in A that have no overlaps with B" help="(-v)" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
68 <expand macro="print_header" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
69 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
70 <outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
71 <data format_source="inputA" name="output" metadata_source="inputA" label=""/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
72 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
73 <tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
74 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
75 <param name="inputA" value="windowBedA.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
76 <param name="inputB" value="windowBedB.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
77 <output name="output" file="windowBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
78 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
79 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
80 <param name="inputA" value="windowBedA.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
81 <param name="inputB" value="windowBedB.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
82 <param name="addition_select" value="window" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
83 <param name="w" value="5000" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
84 <output name="output" file="windowBed_result2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
85 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
86 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
87 <param name="inputA" value="windowBedA.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
88 <param name="inputB" value="windowBedB.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
89 <param name="addition_select" value="lr" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
90 <param name="l" value="200" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
91 <param name="r" value="20000" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
92 <output name="output" file="windowBed_result2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
93 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
94 </tests>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
95 <help>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
96 <![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
97 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
98
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
99 Similar to bedtools intersect, window searches for overlapping features in A and B. However, window adds a specified number (1000, by default) of base pairs upstream and downstream of each feature in A. In effect, this allows features in B that are “near” features in A to be detected.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
100
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
101 .. image:: $PATH_TO_IMAGES/window-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
102
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
103 @REFERENCES@
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
104 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
105 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
106 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
107 </tool>