annotate bedtools-galaxy/coverageBed_counts.xml @ 11:0ee50862dd67 default tip

Uploaded
author aaronquinlan
date Tue, 27 Dec 2011 17:12:28 -0500
parents d72fd57eb158
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
1 <tool id="bedtools_coveragebed_counts" name="Count intervals in one file overlapping intervals in another file." version="0.1.0">
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
2
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
3 <requirements>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
4 <requirement type="binary">coverageBed</requirement>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
5 </requirements>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
6
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
7 <command>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
8 coverageBed
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
9 #if $inputA.ext == "bam"
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
10 -abam '$inputA'
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
11 #else
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
12 -a '$inputA'
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
13 #end if
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
14 -b '$inputB'
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
15 -counts
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
16 $split
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
17 $strand
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
18 | sort -k1,1 -k2,2n
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
19 &gt; '$output'
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
20 </command>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
21
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
22 <inputs>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
23 <param format="bed,bam" name="inputA" type="data" label="Count how many intervals in this BED or BAM file (source)">
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
24 <validator type="unspecified_build" />
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
25 </param>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
26 <param format="bed" name="inputB" type="data" label="overlap the intervals in this BED file (target)">
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
27 <validator type="unspecified_build" />
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
28 </param>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
29 <param name="split" type="boolean" checked="false" 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." />
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
30
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
31 <param name="strand" type="select" label="Count">
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
32 <option value="">overlaps on either strand</option>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
33 <option value="-s">only overlaps occurring on the **same** strand.</option>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
34 <option value="-S">only overlaps occurring on the **opposite** strand.</option>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
35 </param>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
36 </inputs>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
37
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
38 <outputs>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
39 <data format="bed" name="output" metadata_source="inputB" label="count of overlaps in ${inputA.name} on ${inputB.name}"/>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
40 </outputs>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
41
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
42 <help>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
43
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
44 **What it does**
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
45
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
46 This tool converts counts the number of intervals in a BAM or BED file (the source) that overlap another BED file (the target).
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
47
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
48 .. class:: infomark
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
49
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
50 The output file will be comprised of each interval from your original target BED file, plus an additional column indicating the number of intervals in your source file that overlapped that target interval.
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
51
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
52 .. class:: warningmark
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
53
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
54 This tool requires that `bedtools`__ has been installed on your system.
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
55
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
56 ------
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
57
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
58 This tool is part of the `bedtools package`__ from the `Quinlan laboratory`__. If you use this tool, please cite `Quinlan AR, and Hall I.M. BEDTools: A flexible framework for comparing genomic features. Bioinformatics, 2010, 26, 6.`__
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
59
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
60 .. __: http://code.google.com/p/bedtools/
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
61 .. __: http://code.google.com/p/bedtools/
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
62 .. __: http://cphg.virginia.edu/quinlan/
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
63 .. __: http://bioinformatics.oxfordjournals.org/content/26/6/841.short
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
64
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
65 </help>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
66 </tool>