Mercurial > repos > iuc > bedtools

annotate mapBed.xml @ 47:33c2e424ad7d 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 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
author iuc
date Tue, 20 Nov 2018 10:33:07 -0500
parents d279800f4ff9
children 2f457890d8c8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
47
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
1 <tool id="bedtools_map" name="MapBed" version="@WRAPPER_VERSION@.1">
17
a2d4c30ba2f9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0887009a23d176b21536c9fd8a18c4fecc417d4f
iuc
parents: 16
diff changeset
2 <description>apply a function to a column for each overlapping 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" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
9 <![CDATA[
47
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
10 bedtools map
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
11 -a '${inputA}'
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
12 -b '${inputB}'
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
13 $strand
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
14 @C_AND_O_ARGUMENT@
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
15 -f $overlap
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
16 $reciprocal
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
17 $split
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
18 $header
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
19 @GENOME_FILE_MAPBED@
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
20 > '${output}'
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 </command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 <inputs>
42
d279800f4ff9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b75b9e79cf3186a22dc2e1e9d27c1a080b891b59
iuc
parents: 35
diff changeset
24 <param format="bam,@STD_BEDTOOLS_INPUTS@" name="inputA" type="data" label="File A (BAM/@STD_BEDTOOLS_INPUT_LABEL@)" />
d279800f4ff9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b75b9e79cf3186a22dc2e1e9d27c1a080b891b59
iuc
parents: 35
diff changeset
25 <param format="bam,@STD_BEDTOOLS_INPUTS@" name="inputB" type="data" label="File B (BAM/@STD_BEDTOOLS_INPUT_LABEL@)" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
26 <expand macro="overlap" />
26
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 19
diff changeset
27 <param name="reciprocal" type="boolean" checked="false" truevalue="-r" falsevalue=""
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
28 label="Require reciprocal overlap"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 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. (-r)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 <expand macro="strand2" />
16
e30113df8cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 7b8a4ffc823f4dab194f1c629b7e83277dbe4337
iuc
parents: 15
diff changeset
31 <expand macro="c_and_o_argument">
47
33c2e424ad7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 39701b6cbb7a45ec45f1545648b73a6b8ed3e184
iuc
parents: 42
diff changeset
32 <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" />
16
e30113df8cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 7b8a4ffc823f4dab194f1c629b7e83277dbe4337
iuc
parents: 15
diff changeset
33 </expand>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <expand macro="split" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 <expand macro="print_header" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <conditional name="genome">
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
37 <param name="genome_choose" argument="-g" type="select"
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
38 label="Specify a genome file the defines the expected chromosome order in the input files." >
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
39 <option value="" selected="true">No</option>
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
40 <option value="-g">Yes</option>
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
41 </param>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 <when value="-g">
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
43 <expand macro="input_conditional_genome_file" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 </when>
19
102424c60727 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1cfbe7505ebac3b447c6ae0f0d76b42656496588
iuc
parents: 17
diff changeset
45 <when value="" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
46 </conditional>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
48 <outputs>
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
49 <data format_source="inputA" name="output" metadata_source="inputA" label="Mapping of ${inputB.name} into ${inputA.name}" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
50 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
51 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 <param name="inputA" value="mapBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 <param name="inputB" value="mapBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 <repeat name="c_and_o_argument_repeat">
13
bdb4509d9482 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit e8e971905f5fce11a99d51b1399af45288389d76
iuc
parents: 8
diff changeset
56 <param name="col" value="5" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57 <param name="operation" value="mean" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 </repeat>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59 <output name="output" file="mapBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62 <param name="inputA" value="mapBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
63 <param name="inputB" value="mapBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 <repeat name="c_and_o_argument_repeat">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
65 <param name="col" value="5" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
66 <param name="operation" value="collapse" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
67 </repeat>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
68 <output name="output" file="mapBed_result2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
70 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
71 <param name="inputA" value="mapBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
72 <param name="inputB" value="mapBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
73 <repeat name="c_and_o_argument_repeat">
13
bdb4509d9482 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit e8e971905f5fce11a99d51b1399af45288389d76
iuc
parents: 8
diff changeset
74 <param name="col" value="5" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
75 <param name="operation" value="collapse" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
76 </repeat>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
77 <param name="strand" value="-S" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
78 <output name="output" file="mapBed_result3.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
79 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
80 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
81 <param name="inputA" value="mapBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
82 <param name="inputB" value="mapBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
83 <repeat name="c_and_o_argument_repeat">
13
bdb4509d9482 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit e8e971905f5fce11a99d51b1399af45288389d76
iuc
parents: 8
diff changeset
84 <param name="col" value="5" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
85 <param name="operation" value="collapse" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
86 </repeat>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
87 <param name="strand" value="-s" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
88 <output name="output" file="mapBed_result4.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
89 </test>
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
90 <test>
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
91 <param name="inputA" value="mapBed3.bed" ftype="bed" />
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
92 <param name="inputB" value="mapBed4.bed" ftype="bed" />
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
93 <repeat name="c_and_o_argument_repeat">
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
94 <param name="col" value="5" />
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
95 <param name="operation" value="collapse" />
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
96 </repeat>
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
97 <param name="strand" value="-s" />
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
98 <param name="genome_choose" value="-g" />
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
99 <param name="genome_file_opts_selector" value="hist" />
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
100 <param name="genome" value="mm9.len" ftype="bed" />
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
101 <output name="output" file="mapBed_result5.bed" ftype="bed" />
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
102 </test>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
103 </tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
104 <help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
105 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
106 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
107
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
108 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.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
109
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
110 .. image:: $PATH_TO_IMAGES/map-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
111
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
112 .. class:: infomark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
113
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
114 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.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
115
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
116 .. class:: infomark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
117
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
118 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.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
119
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
120 @REFERENCES@
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
121 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
122 </help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
123 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
124 </tool>