GRangesOverlapIndex

GRangesOverlapIndex

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

Classes

GRangesOverlapIndex

Methods

overlap(query, optionsopt) → {Array}

Source:
Parameters:
Name Type Attributes Default Description
query GRanges

The query object, containing ranges to be overlapped with those in the reference GRanges (that was used to construct this GRangesOverlapIndex object).
options Object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
ignoreStrand boolean <optional>
 true

Whether to ignore differences in strandedness between the ranges in query and the reference 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 GRanges object.

Type
Array