find_neighbours: Find neighbour regions

In eilslabs/epic: Integrative Analysis and Visualization of Epigenomic Sequencing Data

Description

Find neighbour regions

Usage

find_neighbours(query, reference, upstream = 1000, downstream = 1000)

Arguments

query	a GRanges object
reference	a GRanges object
upstream	upstream that query is extended
downstream	downstream that query is extended

Details

With a certain extension of query, this funciton looks for reference which intersects the extended regions.

Value

A GRanges object which contains regions in query for which the extended regisons are overlapped with reference. There are three meta columns added:

distance:

distance from the query to corresponding reference

query_index:

index of regions in query

reference_index:

index of regions in reference

Note one reference can correspond to multiple query regions.

Author(s)

Zuguang Gu <[e-mail]>

Examples

gr1 = GRanges(seqname = "chr1", ranges = IRanges(start = c(4, 10), end = c(6, 16)))
gr2 = GRanges(seqname = "chr1", ranges = IRanges(start = c(7, 13), end = c(8, 20)))
find_neighbours(gr1, gr2, upstream = 3, downstream = 3)
find_neighbours(gr1, gr2, upstream = 10, downstream = 10)

eilslabs/epic documentation built on May 16, 2019, 1:24 a.m.