valr (version 0.5.0)

bed_reldist: Compute relative distances between intervals.

Description

Compute relative distances between intervals.

Usage

bed_reldist(x, y, detail = FALSE)

Arguments

x

tbl_interval()

y

tbl_interval()

detail

report relative distances for each x interval.

Value

If detail = FALSE, a tbl_interval() that summarizes calculated .reldist values with the following columns:

• .reldist relative distance metric

• .counts number of metric observations

• .total total observations

• .freq frequency of observation

If detail = TRUE, the .reldist column reports the relative distance for each input x interval.

Details

Interval statistics can be used in combination with dplyr::group_by() and dplyr::do() to calculate statistics for subsets of data. See vignette('interval-stats') for examples.

See Also

http://bedtools.readthedocs.io/en/latest/content/tools/reldist.html

Other interval statistics: bed_absdist, bed_fisher, bed_jaccard, bed_projection

Examples

# NOT RUN {
genome <- read_genome(valr_example('hg19.chrom.sizes.gz'))

x <- bed_random(genome, seed = 1010486)
y <- bed_random(genome, seed = 9203911)

bed_reldist(x, y)

bed_reldist(x, y, detail = TRUE)

# }