coverageBed computes both the depth and breadth of coverage of features in file A across the features in file B. For example, coverageBed can compute the coverage of sequence alignments (file A) across 1 kilobase (arbitrary) windows (file B) tiling a genome of interest. One advantage that coverageBed offers is that it not only counts the number of features that overlap an interval in file B, it also computes the fraction of bases in B interval that were overlapped by one or more features. Thus, coverageBed also computes the breadth of coverage for each interval in B.
Usage:
Option | Description |
---|---|
-abam |
samtools view -b <BAM> | intersectBed -abam stdin -b genes.bed
|
-s | Force strandedness. That is, only features in A are only counted towards coverage in B if they are the same strand. By default, this is disabled and coverage is counted without respect to strand. |
-hist | Report a histogram of coverage for each feature in B as well as a summary histogram for _all_ features in B. Output (tab delimited) after each feature in B:
|
-d | Report the depth at each position in each B feature. Positions reported are one based. Each position and depth follow the complete B feature. |
-split | Treat “split” BAM or BED12 entries as distinct BED intervals when computing coverage. For BAM files, this uses the CIGAR “N” and “D” operations to infer the blocks for computing coverage. For BED12 files, this uses the BlockCount, BlockStarts, and BlockEnds fields (i.e., columns 10,11,12). |
After each interval in B, coverageBed will report:
Below are the number of features in A (N=...) overlapping B and fraction of bases in B with coverage.
Chromosome ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
BED FILE B *********** *********** ** **********
Result [ N=3, 10/15 ] [ N=1, 2/15 ] [N=1,6/6] [N=6, 12/14 ]
For example:
cat A.bed chr1 10 20 chr1 20 30 chr1 30 40 chr1 100 200
cat B.bed chr1 0 100 chr1 100 200 chr2 0 100
coverageBed -a A.bed -b B.bed chr1 0 100 3 30 100 0.3000000 chr1 100 200 1 100 100 1.0000000 chr2 0 100 0 0 100 0.0000000
Use the “-s” option if one wants to only count coverage if features in A are on the same strand as the feature / window in B. This is especially useful for RNA-seq experiments.
For example (note the difference in coverage with and without -s:
cat A.bed chr1 10 20 a1 1 - chr1 20 30 a2 1 - chr1 30 40 a3 1 - chr1 100 200 a4 1 +
cat B.bed chr1 0 100 b1 1 + chr1 100 200 b2 1 - chr2 0 100 b3 1 +
coverageBed -a A.bed -b B.bed chr1 0 100 b1 1 + 3 30 100 0.3000000 chr1 100 200 b2 1 - 1 100 100 1.0000000 chr2 0 100 b3 1 + 0 0 100 0.0000000
coverageBed -a A.bed -b B.bed -s chr1 0 100 b1 1 + 0 0 100 0.0000000 chr1 100 200 b2 1 - 0 0 100 0.0000000 chr2 0 100 b3 1 + 0 0 100 0.0000000
One should use the “-hist” option to create, for each interval in B, a histogram of coverage of the features in A across B.
In this case, each entire feature in B will be reported, followed by the depth of coverage, the number of bases at that depth, the size of the feature, and the fraction covered. After all of the features in B have been reported, a histogram summarizing the coverage among all features in B will be reported.
cat A.bed chr1 10 20 a1 1 - chr1 20 30 a2 1 - chr1 30 40 a3 1 - chr1 100 200 a4 1 +
cat B.bed chr1 0 100 b1 1 + chr1 100 200 b2 1 - chr2 0 100 b3 1 +
coverageBed -a A.bed -b B.bed -hist chr1 0 100 b1 1 + 0 70 100 0.7000000 chr1 0 100 b1 1 + 1 30 100 0.3000000 chr1 100 200 b2 1 - 1 100 100 1.0000000 chr2 0 100 b3 1 + 0 100 100 1.0000000 all 0 170 300 0.5666667 all 1 130 300 0.4333333
One should use the “-d” option to create, for each interval in B, a detailed list of coverage at each of the positions across each B interval.
The output will consist of a line for each one-based position in each B feature, followed by the coverage detected at that position.
cat A.bed chr1 0 5 chr1 3 8 chr1 4 8 chr1 5 9
cat B.bed chr1 0 10
coverageBed -a A.bed -b B.bed -d chr1 0 10 B 1 1 chr1 0 10 B 2 1 chr1 0 10 B 3 1 chr1 0 10 B 4 2 chr1 0 10 B 5 3 chr1 0 10 B 6 3 chr1 0 10 B 7 3 chr1 0 10 B 8 3 chr1 0 10 B 9 1 chr1 0 10 B 10 0
As described in section 1.3.19, coverageBed will, by default, screen for overlaps against the entire span of a spliced/split BAM alignment or blocked BED12 feature. When dealing with RNA-seq reads, for example, one typically wants to only tabulate coverage for the portions of the reads that come from exons (and ignore the interstitial intron sequence). The -split command allows for such coverage to be performed.
This file can be edited directly through the Web. Anyone can update and fix errors in this document with few clicks -- no downloads needed.
For an introduction to the documentation format please see the reST primer.