annotate mapBed.xml @ 0:b8348686a0b9 draft

Imported from capsule None
author iuc
date Tue, 04 Nov 2014 01:45:04 -0500
parents
children 82aac94b06c3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
1 <tool id="bedtools_map" name="MapBed" version="@WRAPPER_VERSION@.0">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
2 <description></description>
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>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
9 bedtools map
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
10 -a $inputA
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
11 -b $inputB
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
12 $strand
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
13 -o $operation
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
14 -c $col
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
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
21 #end if
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
22 &gt; $output
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
23 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 <inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
25 <param format="bed,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF file A"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
26 <param format="bed,gff,vcf,gff3" name="inputB" type="data" label="BED/VCF/GFF file B"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
27 <param name="col" type="integer" value="5" label="Specify the column from the B file to map onto intervals in A" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
28 <expand macro="overlap" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
29 <param name="reciprocal" type="boolean" checked="false" truevalue="-r" falsevalue="" label="Require reciprocal overlap." 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." />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
30 <expand macro="strand2" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
31 <param name="operation" type="select" label="Specify the operation">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32 <option value="sum">Sum - numeric only</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 <option value="absmin">AbsMin - numeric only</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
34 <option value="absmax">AbsMax - numeric only</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
35 <expand macro="math_options" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36 <expand macro="additional_math_options" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
37 </param>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
38 <param name="split" type="boolean" checked="true" truevalue="-split" falsevalue="" label="Treat split/spliced BAM or BED12 entries as distinct BED intervals when computing coverage." help="If set, the coverage will be calculated based the spliced intervals only. For BAM files, this inspects the CIGAR N operation to infer the blocks for computing coverage. For BED12 files, this inspects the BlockCount, BlockStarts, and BlockEnds fields (i.e., columns 10,11,12). If this option is not set, coverage will be calculated based on the interval's START/END coordinates, and would include introns in the case of RNAseq data." />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
39 <param name="header" type="boolean" checked="false" truevalue="-header" falsevalue="" label="Print the header from the A file prior to results." />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
40 <conditional name="genome">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
41 <param name="genome_choose" type="boolean" checked="false" truevalue="-g" falsevalue="" label="Treat split/spliced BAM or BED12 entries as distinct BED intervals when computing coverage." help="" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42 <when value="-g">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
43 <expand macro="genome" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
44 </when>
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>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
50 <help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
51
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
52 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
53
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
54 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
55
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
56 .. image:: $PATH_TO_IMAGES/map-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
57
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
58 .. class:: infomark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
59
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
60 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
61
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
62 .. class:: infomark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
63
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
64 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
65
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
66 @REFERENCES@
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
67
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
68 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
69 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
70 </tool>