findOverlaps-methods: find overlaps in bioconductor / IRanges: basic integer range manipulation in bioconductor (2023)

findOverlaps method

R documentation

Find overlapping ranges

Description

The different methods for finding/counting ranges overlap between two "range-based" objects: the query and the subject.

NOTE: This page of the manual describes methods that operate on IntegerRanges and IntegerRangesList derivatives. Ver?`findOverlaps,GenomicRanges,GenomicRanges-metoda`wgenomic rangespackage for methods that operate on GenomicRanges or GRangesListobjects.

To use

findOverlaps(query, subject, maxgap=-1L, minoverlap=0L, type=c("any", "start", "end", "within", "equal"), select=c("all", "first ", "last", "arbitrary"), ...) countOverlaps (query, subject, maxgap=-1L, minoverlap=0L, type=c("any", "start", "end", "inside", "equals"), ...)overlapsAny(query, subject, maxgap=-1L, minoverlap=0L, type=c("any", "beginning", "end", "within", "equals"), . ..) query %over% itemquery %inside%query%outside%subsetByOverlaps(x, ranges, maxgap=-1L, minoverlap=0L, type=c("any", "begin", "end", "inside", "equal"), invert=FALSE, ...)overlaps(query, subject, hits=NULL, ...)poverlaps(query, subject, maxgap = 0L, minoverlap = 1L, type = c("any", " start", "end", "within", "equals"), ...) mergeByOverlaps(query, subject, ...) findOverlapPairs(query, subject, ...)

arguments

`query, subject, x, ranks`	Each of these can be derived from IntegerRanges (for example, IRanges, Views) or IntegerRangesList (for example, IRangesList, ViewsList). Furthermore, if`him`lubricant`contracts`is an IntegerRangs object,`consultation`lubricant`X`can be an integer vector to convert to ranges of length one. And`consultation`(Lub`X`) is therefore an IntegerRangesList object`him`(Lub`contracts`) must also be an IntegerRangesList object. If both arguments are named as list objects, each list item in the second argument is matched with the list item in the first star item with the matching name, if any. Otherwise, the list items are matched by position. The overlap between the pairs is then calculated as described below. And`him`is omitted`consultation`he wonders against himself. In this case and only in this case`drop. myself`I`redundant`Arguments are allowed. By default, the score will include hits for each rank against itself, and if there is a hit from A to B, there is a hit from B to A. If`drop. myself`Es`TRUE`, all custom matches are rejected. Yeah`redundant`Es`TRUE`, only one of A->B and B->A is returned.
`maximum rest`	Single integer >= -1. And`type`is set to`"all"`,`maximum rest`is interpreted as maximumlucawhich is allowed between 2 ranges for the ranges to be considered overlapping. Helucabetween 2 ranges is the number of elements that divide them. Helucabetween two adjacent ranges is 0. By convention, when one range has its beginning or end strictly within the other (i.e., inseparable ranges),luca-1 is considered. And`type`is set to anything else`maximum rest`has a special meaning that depends on the specific`type`. Ver`type`below for more information.
`small overlap`	A single nonnegative integer. Only ranges with a minimum`small overlap`overlapping positions are considered overlapping. When`type`Es`"all"`at least one of`maximum rest`I`small overlap`should be set to the default value.
`type`	Any overlap is accepted by default. defining`type`The parameter can be selected for certain types of overlay. The types correspond to operations in Allen interval algebra (see references). Yeah`type`Es`beginning`lubricant`fin`, the intervals must have matching beginnings or endings. Determination`equal`because the type returns an intersection`beginning`I`fin`matches. Yeah`type`Es`w`, the query range must be completely contained within the subject range. Please note that all parties must additionally comply with the conditions`small overlap`limitation described above. He`maximum rest`the parameter has special meaning for special overlay types. For`beginning`,`fin`, I`equal`, specifies the maximum difference in starts, ends, or both, respectively. For`w`, this is the maximum amount by which the topic can be broader than the query. Yeah`maximum rest`set to -1 (default), internally replaced by 0.
`choose`	And`consultation`derives from IntegerRanges:When`choose`Es`"All"`(default), results are returned as a Hits object. Otherwise, the return value is an integer vectorparallelDo`consultation`(i.e., of the same length) that contains the first, last, or any overlapping interval in`him`, z`A`indicating intervals that did not overlap with any interval in`him`. And`consultation`se deriva de IntegerRangesList:When`choose`Es`"All"`(default), the results are returned as a HitsList object. Otherwise, the return value depends on`drop`argument. When`select != "all" && !drop`, a list of integers is returned, where each element of the result corresponds to a space in`consultation`.When`select != "all" && drop`, an array of integers is returned containing the indices that are shifted to align with the unenumerated`consultation`.
`counter`	And`TRUE`, keep ranges only`X`do itNOoverlap`contracts`.
`hits`	The Hits or HitsList object returned by`findoverlap`Lub`ZERO`. And`ZERO`So`hits`is calculated per call`findOverlaps(query, subject, ...)`internally (additional arguments passed to`the ranges overlap`are forwarded to`findoverlap`).
`...`	Other arguments to be passed to or from other methods: `drop`: Supported only when`consultation`is a derivative of the IntegerRangesList type.`FALSEHOOD`default. See`choose`above argument for more details. `drop. myself`,`redundant`: When`him`is omitted, that is`drop. myself`I`redundant`arguments (both`FALSEHOOD`default) are allowed. Look`consultation`I`him`above arguments for details.

Details

A common type of query that arises when working with containers is determining which containers in one set overlap with containers in another.

The simplest approach is to callfindoverlapfunction on IntegerRanges or some other object with range information (also known as a "range-based object").

(Video) ATACseq in Bioconductor (Part 2)

Valor

Forfindoverlap: verchooseprevious argument.

Fornumber overlays: number of overlapping matches for each rangeconsultationusing the givenfindoverlapparameters For IntegerRangesList objects, returns an IntegerListobject object.

applies to anyfind ranges inconsultationthat match any range inhim. For derivatives, IntegerRanges returns a logical vector with length equal to the number of ranges inconsultation. For derivatives, IntegerRangesList returns a LogicalList object where each element of the result corresponds to a space inconsultation.

%they%I%w%they are convenient packages for the 2 most common use cases. currently defined as`%over%` <- function(query, subject) overlaps Any(query, subject)I`%w%` <- function(query, subject) overlaps Any(query, subject, type="inside").%apart from%it's the opposite%they%.

(Video) Summarizing Scores In Bioconductor

subsetByOverlaysreturns a subsetXwhich has an overlapping punch with a range of wcontractsusing the givenfindoverlapparameters

Whenhitsis a Hits (or HitsList) object,overlapRanges(query, subject, hits)returns an aIntegerRanges (or IntegerRangesList) objectsame shapeAshitsmaintenance of intersection areas between overlapping ranges in objectsconsultationIhimwhich should be the same query and subject used in the call tofindoverlapgeneratedhits.same shapemeans the same length whenhitsis a Hits object, has the same length and the same NROWS element whenhitsis a HitsList object.

halvescompareconsultationIhimin parallel (ex.min) and returns a boolean value indicating whether each pair of ranges matches. Integer vectors are treated as ranges of width one.

overlap fusioncalculates the query and topic overlap according to the arguments in.... It then extracts the relevant hits from each object and returns adata framecontaining a column for the query and another for the subject, and anymcolsthat were present in both elements. The query and subject columns are named by quoting and parsing the appropriate arguments.

(Video) Introduction to Bioconductor (Part 1)

find overlapping pairsit is likeoverlap fusion, except that it returns formalcouplesan object that provides other useful functions, such as finding the intersection of overlapping z-rangestransversal.

from the author)

The Hervé page by Michaela Lawrence

Bibliography

Allen's interval algebra: James F. Allen: Maintaining knowledge of time intervals. In: ACM Announcements. November 26, 1983. ACM Press. S.832-843, ISSN 0001-0782

examples

## ---------------------------------------------------------------- ---------------------## findOverlays()## ------- --------------- ---------------------------------query < - IRanges(c(1, 4, 9), c(5). , 7, 10))issue <- IRanges(c(2, 2, 10), c(2, 3, 12))findOverlaps(query, issue) # # as at most one match per queryfindOverlaps(query, issue, select= "first")findOverlaps(query, issue, select="last")findOverlaps(query, issue, select="arbitraly")## include adjacent ranges in the result of findOverlaps (query, issue, maximum space=0L)query < - IRanges (c(1, 4, 9), c(5, 7, 10))subject <- IRanges(c(2, 2), c(5, 4) ) )## an IRanges object with itselffindOverlaps(query )# # individual points as query object special type query <- IRanges(c(1, 5, 3, 4), width=c(2, 2, 4, 6))subject <- IRanges(c(1, 4), 4). 3, 5, 6), width=c (4, 4, 5, 4))findOverlaps(query, issue, type="start")findOverlaps(query, issue, type="start", maxgap =1L)findOverlaps(; query, issue, type="end", select="first")ov <- findOverlaps(query, subject, type="within", maxgap=1L)ov## Using pairs to find the intersection of overlapping ranges <- findOverlaps(query, subject)p <- Pairs ( query, issue, hits=hit)pintersect(p)## Shortcut <- findOverlapPairs(query, issue)pintersect(p)## ------- --- -- --------- ------- ----- -------## overlaps Any()## ----------- --- --------- ------------- ------------------overlapsAny(query, issue, type ="start")overlapsAny(query, issue, type ="end") query %on% issue # same as overlapAny(query, issue) query %within% issue # same as overlapAny(query, issue, # type= "within ")## ------ -- ----------- ------------- -------------# # overlapping ranges( )## --------------- - ---------------------------- --- --------## Extract areas of intersection between overlapping ranges: overlapsRanges(query, subject, ov)## -------------- ----- -- -- --------------## Using IntegerRangeList## ------------ -------------- - ---------------------------------- - ------query <- IRanges(c(1). , 4, 9), c(5, 7, 10))qpartition <-factor(c("a","a","b")) qlist <- split(query, qpartition)subject <-IRRanges(c ( 2, 2, 10), c(2, 3, 12)) split <-factor(c("a","a","b" ) )slist <- split(issue, partition)## max one hit on queryfindOverlap(qlist, slist, select="first")findOverlap(qlist, slist, select="last")findOverlap(qlist, slist, select="arbitrary") query <- IRanges(c(1, 5, 3). , 4), width=c(2, 2, 4, 6))qpartition <-factor(c("a","a","b" ,,b"))qlist <- division(query, qpartition) entity <- IRanges(c(1, 3, 5, 6), width=c(4, 4, 5, 4)) division <- factor(c("a","a","b","b " ))list <- split(issue, partition)overlapAny(qlist, list, type="start")overlapAny(qlist, list, type="end" )qlist subsetByOverlap(qlist, list)countOverlap(qlist, list);