Mercurial > repos > iuc > bedtools

annotate windowBed.xml @ 50:df28283b3778 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
author iuc
date Mon, 29 Apr 2019 05:54:22 -0400
parents 2f457890d8c8
children 7a06bb42dbb1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
1 <tool id="bedtools_windowbed" name="bedtools WindowBed" version="@TOOL_VERSION@">
17
a2d4c30ba2f9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0887009a23d176b21536c9fd8a18c4fecc417d4f
iuc
parents: 8
diff changeset
2 <description>find overlapping intervals within a window around an interval</description>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
3 <macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
5 </macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
8 <command><![CDATA[
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
9 bedtools window
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
10 #if $inputA.is_of_type('bam'):
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
11 -abam '$inputA'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
12 #else:
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
13 -a '$inputA'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
14 #end if
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
15 -b '$inputB'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
16 $bed
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
17 $strandB
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
18 #if $addition.addition_select == 'window':
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
19 -w $addition.w
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
20 #elif $addition.addition_select == 'lr':
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
21 -l $addition.l
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
22 -r $addition.r
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
23 #end if
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
24 $original
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
25 $number
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
26 $nooverlaps
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
27 $header
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
28 > '$output'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
29 ]]></command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 <inputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
31 <param name="inputA" type="data" format="bam,@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@/BAM file"/>
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
32 <param name="inputB" argument="-b" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
33 <param argument="-bed" type="boolean" truevalue="-bed" falsevalue="" checked="false"
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
34 label="When using BAM input, write output as BED. The default is to write output in BAM when using a BAM file" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 <conditional name="addition">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <param name="addition_select" type="select" label="Choose what you want to do">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 <option value="window">Add Base pairs for **both** upstream and downstream of each entry in A when searching for overlaps in B</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 <option value="lr">Add Base pairs **separately** for upstream and downstream of each entry in A when searching for overlaps in B</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 </param>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 <when value="window">
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
41 <param argument="-w" type="integer" value="1000" label="Base pairs to add upstream and downstream" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 </when>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 <when value="lr">
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
44 <param argument="-l" type="integer" value="1000"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 label="Base pairs added upstream (left) of each entry in A when searching for overlaps in B"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
46 help="Allows one to create assymetrical “windows”. Default is 1000bp." />
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
47 <param argument="-r" type="integer" value="1000"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
48 label="Base pairs added downstream (right) of each entry in A when searching for overlaps in B"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
49 help="Allows one to create assymetrical “windows”. Default is 1000bp." />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
50 </when>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
51 </conditional>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52 <param name="strandB" type="select" label="Calculation based on strandedness?">
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
53 <option value="" selected="true">Report any hit in B</option>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 <option value="-sm">Only report hits in B that overlap A on the **same** strand</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 <option value="-Sm">Only report hits in B that overlap A on the **opposite** strand</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 </param>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
57 <param name="original" argument="-u" type="boolean" truevalue="-u" falsevalue="" checked="false"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 label="Write original A entry once if any overlaps found in B"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
59 help="In other words, just report the fact at least one overlap was found in B" />
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
60 <param name="number" argument="-c" type="boolean" truevalue="-c" falsevalue="" checked="false"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 label="For each entry in A, report the number of hits in B"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
62 help="Reports 0 for A entries that have no overlap with B" />
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
63 <param name="nooverlaps" argument="-v" type="boolean" truevalue="-v" falsevalue="" checked="false"
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
64 label="Only report those entries in A that have no overlaps with B" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
65 <expand macro="print_header" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
66 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
67 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
68 <data name="output" format_source="inputA" metadata_source="inputA" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
70 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
71 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
72 <param name="inputA" value="windowBedA.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
73 <param name="inputB" value="windowBedB.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
74 <output name="output" file="windowBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
75 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
76 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
77 <param name="inputA" value="windowBedA.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
78 <param name="inputB" value="windowBedB.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
79 <param name="addition_select" value="window" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
80 <param name="w" value="5000" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
81 <output name="output" file="windowBed_result2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
82 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
83 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
84 <param name="inputA" value="windowBedA.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
85 <param name="inputB" value="windowBedB.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
86 <param name="addition_select" value="lr" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
87 <param name="l" value="200" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
88 <param name="r" value="20000" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
89 <output name="output" file="windowBed_result2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
90 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
91 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
92 <help><![CDATA[
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
93 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
94
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
95 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.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
96
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
97 .. image:: $PATH_TO_IMAGES/window-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
98
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
99 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
100 ]]></help>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
101 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
102 </tool>