GroupedGRangesOverlapIndex

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

Classes

GroupedGRangesOverlapIndex

Methods

overlap(query, optionsopt) → {Array}

Source:

GroupedGRanges.js, line 410

Parameters:

Name Type Attributes Default Description

query

GroupedGRanges | GRanges

The query object, containing ranges to be overlapped with those in the reference GroupedGRanges (that was used to construct this GroupedGRangesOverlapIndex object).

options

Object

{}

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 or groups in query, where each element is an array containing the indices of the overlapping ranges in the reference GRanges object.

Type: Array