annotate mapBed.xml @ 24:679fbed9d08f draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 9555dac6cbff70048b682a6514c7fbb2b7fbb975
author iuc
date Mon, 05 Sep 2016 15:27:44 -0400
parents 102424c60727
children c0fbce5dc84a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
0d3aa592ce27 Uploaded
iuc
parents:
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[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
10 bedtools map
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
11 -a "${inputA}"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
12 -b "${inputB}"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
13 $strand
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
14 @C_AND_O_ARGUMENT@
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
15 -f $overlap
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
16 $reciprocal
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
17 $split
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
18 $header
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
19 #if $genome.genome_choose == "-g" :
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
20 -g $genome.genome
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 #end if
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 > "${output}"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 </command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 <inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
26 <param format="bam,bed,vcf,gff,gff3" name="inputA" type="data" label="File A (BAM/BED/VCF/GFF)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
27 <param format="bam,bed,gff,vcf,gff3" name="inputB" type="data" label="File B (BAM/BED/VCF/GFF)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
28 <expand macro="overlap" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 <param name="reciprocal" type="boolean" checked="false" truevalue="-r" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 label="Require reciprocal overlap"
0d3aa592ce27 Uploaded
iuc
parents:
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. (-r)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 <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
33 <expand macro="c_and_o_argument">
e30113df8cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 7b8a4ffc823f4dab194f1c629b7e83277dbe4337
iuc
parents: 15
diff changeset
34 <param name="col" type="data_column" data_ref="inputA" label="Specify the column(s) that should be summarized" help="(-c)" />
e30113df8cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 7b8a4ffc823f4dab194f1c629b7e83277dbe4337
iuc
parents: 15
diff changeset
35 </expand>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <expand macro="split" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 <expand macro="print_header" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 <conditional name="genome">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 <param name="genome_choose" type="boolean" checked="false" truevalue="-g" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 label="Treat split/spliced BAM or BED12 entries as distinct BED intervals when computing coverage." help="(-g)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <when value="-g">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 <expand macro="genome" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 </when>
19
102424c60727 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1cfbe7505ebac3b447c6ae0f0d76b42656496588
iuc
parents: 17
diff changeset
44 <when value="" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 </conditional>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
46 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 <outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
48 <data format_source="inputA" name="output" metadata_source="inputA" label="Mapping of ${inputB.name} into ${inputA.name}"/>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
49 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
50 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
51 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52 <param name="inputA" value="mapBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 <param name="inputB" value="mapBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 <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
55 <param name="col" value="5" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 <param name="operation" value="mean" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57 </repeat>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 <output name="output" file="mapBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 <param name="inputA" value="mapBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62 <param name="inputB" value="mapBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
63 <repeat name="c_and_o_argument_repeat">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 <param name="col" value="5" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
65 <param name="operation" value="collapse" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
66 </repeat>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
67 <output name="output" file="mapBed_result2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
68 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
70 <param name="inputA" value="mapBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
71 <param name="inputB" value="mapBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
72 <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
73 <param name="col" value="5" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
74 <param name="operation" value="collapse" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
75 </repeat>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
76 <param name="strand" value="-S" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
77 <output name="output" file="mapBed_result3.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
78 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
79 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
80 <param name="inputA" value="mapBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
81 <param name="inputB" value="mapBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
82 <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
83 <param name="col" value="5" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
84 <param name="operation" value="collapse" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
85 </repeat>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
86 <param name="strand" value="-s" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
87 <output name="output" file="mapBed_result4.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
88 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
89 </tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
90 <help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
91 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
92 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
93
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
94 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
95
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
96 .. image:: $PATH_TO_IMAGES/map-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
97
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
98 .. class:: infomark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
99
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
100 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
101
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
102 .. class:: infomark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
103
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
104 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
105
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
106 @REFERENCES@
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
107 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
108 </help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
109 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
110 </tool>