Mercurial > repos > iuc > bedtools

annotate mapBed.xml @ 34:dde39ba9c031 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:55:48 -0400
parents 4f7a5ccd2ae9
children ce3c7f062223
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_map" name="bedtools MapBed" version="@TOOL_VERSION@.2">
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 3
diff changeset
2 <description>apply a function to a column for each overlapping 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" />
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
8 <command><![CDATA[
31
e19bebe96cd2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 26
diff changeset
9 bedtools map
e19bebe96cd2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 26
diff changeset
10 -a '${inputA}'
e19bebe96cd2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 26
diff changeset
11 -b '${inputB}'
e19bebe96cd2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 26
diff changeset
12 $strand
e19bebe96cd2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 26
diff changeset
13 @C_AND_O_ARGUMENT@
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
14 @OVERLAP@
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
15 #if str($overlapB):
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
16 -F $overlapB
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
17 #end if
31
e19bebe96cd2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 26
diff changeset
18 $reciprocal
e19bebe96cd2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 26
diff changeset
19 $split
e19bebe96cd2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 26
diff changeset
20 $header
e19bebe96cd2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 26
diff changeset
21 @GENOME_FILE_MAPBED@
e19bebe96cd2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 26
diff changeset
22 > '${output}'
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
23 ]]></command>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 <inputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
25 <param name="inputA" argument="-a" type="data" format="bam,@STD_BEDTOOLS_INPUTS@" label="File A (BAM/@STD_BEDTOOLS_INPUT_LABEL@)" />
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
26 <param name="inputB" argument="-b" type="data" format="bam,@STD_BEDTOOLS_INPUTS@" label="File B (BAM/@STD_BEDTOOLS_INPUT_LABEL@)" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
27 <expand macro="overlap" />
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
28 <expand macro="overlap" name="overlapB" argument="-F" fracof="B"/>
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
29 <param name="reciprocal" argument="-r" type="boolean" truevalue="-r" falsevalue="" checked="false"
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
30 label="Require reciprocal overlap"
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
31 help="If set, the overlap between the BAM alignment and the BED interval must affect the above fraction of both the alignment and the BED interval" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32 <expand macro="strand2" />
3
2cd7e321d259 Uploaded
iuc
parents: 2
diff changeset
33 <expand macro="c_and_o_argument">
31
e19bebe96cd2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 26
diff changeset
34 <param name="col" argument="-c" type="data_column" data_ref="inputB" label="Specify the column(s) from the B file to map onto intervals in A" help="Multiple columns can be specified in a comma-delimited list" />
3
2cd7e321d259 Uploaded
iuc
parents: 2
diff changeset
35 </expand>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
36 <expand macro="split" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
37 <expand macro="print_header" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
38 <conditional name="genome">
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
39 <param name="genome_choose" argument="-g" type="select"
17
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
40 label="Specify a genome file the defines the expected chromosome order in the input files." >
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
41 <option value="" selected="true">No</option>
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
42 <option value="-g">Yes</option>
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
43 </param>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
44 <when value="-g">
17
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
45 <expand macro="input_conditional_genome_file" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
46 </when>
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 3
diff changeset
47 <when value="" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
48 </conditional>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
49 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
50 <outputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
51 <data name="output" format_source="inputA" metadata_source="inputA" label="Mapping of ${inputB.name} into ${inputA.name}" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
52 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
53 <tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
54 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
55 <param name="inputA" value="mapBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
56 <param name="inputB" value="mapBed2.bed" ftype="bed" />
2
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
57 <repeat name="c_and_o_argument_repeat">
3
2cd7e321d259 Uploaded
iuc
parents: 2
diff changeset
58 <param name="col" value="5" />
2
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
59 <param name="operation" value="mean" />
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
60 </repeat>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
61 <output name="output" file="mapBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
62 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
63 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
64 <param name="inputA" value="mapBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
65 <param name="inputB" value="mapBed2.bed" ftype="bed" />
2
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
66 <repeat name="c_and_o_argument_repeat">
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
67 <param name="col" value="5" />
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
68 <param name="operation" value="collapse" />
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
69 </repeat>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
70 <output name="output" file="mapBed_result2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
71 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
72 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
73 <param name="inputA" value="mapBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
74 <param name="inputB" value="mapBed2.bed" ftype="bed" />
2
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
75 <repeat name="c_and_o_argument_repeat">
3
2cd7e321d259 Uploaded
iuc
parents: 2
diff changeset
76 <param name="col" value="5" />
2
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
77 <param name="operation" value="collapse" />
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
78 </repeat>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
79 <param name="strand" value="-S" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
80 <output name="output" file="mapBed_result3.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
81 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
82 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
83 <param name="inputA" value="mapBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
84 <param name="inputB" value="mapBed2.bed" ftype="bed" />
2
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
85 <repeat name="c_and_o_argument_repeat">
3
2cd7e321d259 Uploaded
iuc
parents: 2
diff changeset
86 <param name="col" value="5" />
2
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
87 <param name="operation" value="collapse" />
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
88 </repeat>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
89 <param name="strand" value="-s" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
90 <output name="output" file="mapBed_result4.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
91 </test>
17
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
92 <test>
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
93 <param name="inputA" value="mapBed3.bed" ftype="bed" />
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
94 <param name="inputB" value="mapBed4.bed" ftype="bed" />
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
95 <repeat name="c_and_o_argument_repeat">
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
96 <param name="col" value="5" />
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
97 <param name="operation" value="collapse" />
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
98 </repeat>
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
99 <param name="strand" value="-s" />
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
100 <param name="genome_choose" value="-g" />
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
101 <param name="genome_file_opts_selector" value="hist" />
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
102 <param name="genome" value="mm9.len" ftype="bed" />
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
103 <output name="output" file="mapBed_result5.bed" ftype="bed" />
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
104 </test>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
105 </tests>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
106 <help><![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
107 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
108
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
109 bedtools map allows one to map overlapping features in a B file onto features in an A file and apply statistics and/or summary operations on those features.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
110
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
111 .. image:: $PATH_TO_IMAGES/map-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
112
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
113 .. class:: infomark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
114
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
115 bedtools map requires each input file to be sorted by genome coordinate. For BED files, this can be done with sort -k1,1 -k2,2n. Other sorting criteria are allowed if a genome file (-g) is provides that specifies the expected chromosome order.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
116
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
117 .. class:: infomark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
118
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
119 The map tool is substantially faster in versions 2.19.0 and later. The plot below demonstrates the increased speed when, for example, counting the number of exome alignments that align to each exon. The bedtools times are compared to the bedops bedmap utility as a point of reference.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
120
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
121 @REFERENCES@
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
122 ]]></help>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
123 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
124 </tool>