annotate intersectbed.xml @ 20:16ba480adf96

Uploaded
author xuebing
date Sat, 31 Mar 2012 08:31:22 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
1 <tool id="intersectbed" name="intersectBed">
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
2 <description>intersect two interval sets</description>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
3 <command> intersectBed -a $inputa -b $inputb $output_opt $strandness $r -f $f $split > $output_data
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
4 </command>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
5 <inputs>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
6 <param name="inputa" type="data" format="interval,bam,bed,gff,vcf" label="Input A (-a)"/>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
7 <param name="inputb" type="data" format="interval,bam,bed,gff,vcf" label="Input B (-b)"/>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
8 <param name="output_opt" type="select" label="Output style" >
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
9 <option value="-wa" selected="true"> -wa: entry in A that overlaps B</option>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
10 <option value="-wb" > -wb: entry in B that overlaps A</option>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
11 <option value="-wo" > -wo: A,B, and num bases overlap </option>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
12 <option value="-wao" > -wao: A,B, and num bases overlap </option>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
13 <option value="-u" > -u: A only </option>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
14 <option value="-c" > -c: A, num B features overlap </option>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
15 <option value="-v" > -v: A without overlap </option>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
16 </param>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
17
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
18 <param name="f" size="10" type="float" value="1E-9" label="Minimum overlap required as a fraction of A"/>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
19
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
20 <param name="strandness" type="select" label="Strand requirement" >
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
21 <option value="" selected="true"> none </option>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
22 <option value="-s" > -s: require overlap on the same strand</option>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
23 <option value="-S" > -S: require overlap on the opposite strand </option>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
24 </param>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
25
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
26 <param name="r" label="Require that the fraction overlap be reciprocal for A and B (-r)." type="boolean" truevalue="-r" falsevalue="" checked="False"/>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
27 <param name="split" label="Treat'split' BAM or BED12 entries as distinct BED intervals (-split)." type="boolean" truevalue="-split" falsevalue="" checked="False"/></inputs>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
28 <outputs>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
29 <data format="bed" name="output_data"/>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
30 </outputs>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
31 <help>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
32
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
33 **What it does**
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
34
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
35 This is a wrapper for intersecBed.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
36
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
37 Program: intersectBed (v2.13.3)
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
38 Author: Aaron Quinlan (aaronquinlan@gmail.com)
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
39 Summary: Report overlaps between two feature files.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
40
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
41 Usage::
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
42
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
43 intersectBed [OPTIONS] -a (bed/gff/vcf) -b (bed/gff/vcf)
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
44
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
45 Options::
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
46 -abam The A input file is in BAM format. Output will be BAM as well.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
47
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
48 -ubam Write uncompressed BAM output. Default is to write compressed BAM.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
49
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
50 -bed When using BAM input (-abam), write output as BED. The default
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
51 is to write output in BAM when using -abam.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
52
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
53 -wa Write the original entry in A for each overlap.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
54
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
55 -wb Write the original entry in B for each overlap.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
56 - Useful for knowing _what_ A overlaps. Restricted by -f and -r.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
57
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
58 -wo Write the original A and B entries plus the number of base
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
59 pairs of overlap between the two features.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
60 - Overlaps restricted by -f and -r.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
61 Only A features with overlap are reported.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
62
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
63 -wao Write the original A and B entries plus the number of base
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
64 pairs of overlap between the two features.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
65 - Overlapping features restricted by -f and -r.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
66 However, A features w/o overlap are also reported
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
67 with a NULL B feature and overlap = 0.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
68
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
69 -u Write the original A entry _once_ if _any_ overlaps found in B.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
70 - In other words, just report the fact >=1 hit was found.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
71 - Overlaps restricted by -f and -r.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
72
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
73 -c For each entry in A, report the number of overlaps with B.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
74 - Reports 0 for A entries that have no overlap with B.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
75 - Overlaps restricted by -f and -r.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
76
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
77 -v Only report those entries in A that have _no overlaps_ with B.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
78 - Similar to "grep -v" (an homage).
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
79
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
80 -f Minimum overlap required as a fraction of A.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
81 - Default is 1E-9 (i.e., 1bp).
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
82 - FLOAT (e.g. 0.50)
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
83
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
84 -r Require that the fraction overlap be reciprocal for A and B.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
85 - In other words, if -f is 0.90 and -r is used, this requires
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
86 that B overlap 90% of A and A _also_ overlaps 90% of B.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
87
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
88 -s Require same strandedness. That is, only report hits in B that
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
89 overlap A on the _same_ strand.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
90 - By default, overlaps are reported without respect to strand.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
91
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
92 -S Require different strandedness. That is, only report hits in B that
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
93 overlap A on the _opposite_ strand.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
94 - By default, overlaps are reported without respect to strand.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
95
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
96 -split Treat "split" BAM or BED12 entries as distinct BED intervals.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
97
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
98 -sorted Use the "chromsweep" algorithm for sorted (-k1,1 -k2,2n) input
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
99 NOTE: this will trust, but not enforce that data is sorted. Caveat emptor.
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
100
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
101 </help>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
102 </tool>
16ba480adf96 Uploaded
xuebing
parents:
diff changeset
103