annotate mapBed.xml @ 4:607c0576c6ab draft

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