IRangesOverlapIndex

Pre-built index for overlapping IRanges objects. This is typically constructed using the IRanges.buildOverlapIndex method for a "reference" object, and can be applied to different query IRanges to identify overlaps with the reference.

Classes

IRangesOverlapIndex

Methods

overlap(query) → {Array}

Source:

IRanges.js, line 228

Parameters:

Name	Type	Description
`query`	IRanges	The query object, containing ranges to be overlapped with those in the reference IRanges (that was used to construct this IRangesOverlapIndex object).

Returns:

An array of length equal to the number of ranges in query, where each element is an array containing the indices of the overlapping ranges in the reference IRanges object.

Type: Array