annotate mapBed.xml @ 4:315929597efb draft

Uploaded
author iuc
date Wed, 07 Jan 2015 12:45:05 -0500
parents 7511823bdea1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
1 <tool id="bedtools_map" name="MapBed" version="@WRAPPER_VERSION@.0">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
2 <description></description>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
3 <macros>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
5 </macros>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
8 <command>
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
9 <![CDATA[
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
10 bedtools map
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
11 -a "${inputA}"
315929597efb Uploaded
iuc
parents: 1
diff changeset
12 -b "${inputB}"
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
13 $strand
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
14 -o $operation
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
15 -c "${cols}"
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
16 -f $overlap
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
17 $reciprocal
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
18 $split
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
19 $header
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
20 #if $genome.genome_choose == "-g" :
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
21 -g $genome.genome
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
22 #end if
315929597efb Uploaded
iuc
parents: 1
diff changeset
23 > "${output}"
315929597efb Uploaded
iuc
parents: 1
diff changeset
24 ]]>
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
25 </command>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
26 <inputs>
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
27 <param format="bam,bed,vcf,gff,gff3" name="inputA" type="data" label="File A (BAM/BED/VCF/GFF)" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
28 <param format="bam,bed,gff,vcf,gff3" name="inputB" type="data" label="File B (BAM/BED/VCF/GFF)" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
29 <expand macro="choose_columns" />
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
30 <expand macro="overlap" />
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
31 <param name="reciprocal" type="boolean" checked="false" truevalue="-r" falsevalue=""
315929597efb Uploaded
iuc
parents: 1
diff changeset
32 label="Require reciprocal overlap"
315929597efb Uploaded
iuc
parents: 1
diff changeset
33 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
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
34 <expand macro="strand2" />
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
35 <expand macro="choose_operations">
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
36 <expand macro="math_options" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
37 <expand macro="additional_math_options" />
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
38 </expand>
315929597efb Uploaded
iuc
parents: 1
diff changeset
39 <expand macro="split" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
40 <expand macro="print_header" />
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
41 <conditional name="genome">
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
42 <param name="genome_choose" type="boolean" checked="false" truevalue="-g" falsevalue=""
315929597efb Uploaded
iuc
parents: 1
diff changeset
43 label="Treat split/spliced BAM or BED12 entries as distinct BED intervals when computing coverage." help="(-g)" />
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
44 <when value="-g">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
45 <expand macro="genome" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
46 </when>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
47 </conditional>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
48 </inputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
49 <outputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
50 <data format_source="inputA" name="output" metadata_source="inputA" label="Mapping of ${inputB.name} into ${inputA.name}"/>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
51 </outputs>
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
52 <tests>
315929597efb Uploaded
iuc
parents: 1
diff changeset
53 <test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
54 <param name="inputA" value="mapBed1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
55 <param name="inputB" value="mapBed2.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
56 <param name="cols" value="5" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
57 <param name="operation" value="mean" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
58 <output name="output" file="mapBed_result1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
59 </test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
60 <test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
61 <param name="inputA" value="mapBed1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
62 <param name="inputB" value="mapBed2.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
63 <param name="cols" value="5" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
64 <param name="operation" value="collapse" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
65 <output name="output" file="mapBed_result2.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
66 </test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
67 <test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
68 <param name="inputA" value="mapBed1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
69 <param name="inputB" value="mapBed2.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
70 <param name="cols" value="5" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
71 <param name="operation" value="collapse" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
72 <param name="strand" value="-S" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
73 <output name="output" file="mapBed_result3.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
74 </test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
75 <test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
76 <param name="inputA" value="mapBed1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
77 <param name="inputB" value="mapBed2.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
78 <param name="cols" value="5" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
79 <param name="operation" value="collapse" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
80 <param name="strand" value="-s" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
81 <output name="output" file="mapBed_result4.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
82 </test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
83 </tests>
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
84 <help>
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
85 <![CDATA[
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
86 **What it does**
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
87
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
88 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.
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
89
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
90 .. image:: $PATH_TO_IMAGES/map-glyph.png
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
91
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
92 .. class:: infomark
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
93
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
94 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.
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
95
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
96 .. class:: infomark
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
97
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
98 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.
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
99
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
100 @REFERENCES@
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
101 ]]>
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
102 </help>
1
7511823bdea1 Uploaded
iuc
parents: 0
diff changeset
103 <expand macro="citations" />
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
104 </tool>