IntervalSurgeon-package {IntervalSurgeon}

Operating on Integer-Bounded Intervals

Description

Manipulate integer-bounded intervals including finding overlaps, piling and merging.

Details

The DESCRIPTION file:

Package:	IntervalSurgeon
Type:	Package
Title:	Operating on Integer-Bounded Intervals
Encoding:	UTF-8
Version:	1.3
Date:	2024-02-20
Author:	Daniel Greene
Maintainer:	Daniel Greene <[e-mail]>
Description:	Manipulate integer-bounded intervals including finding overlaps, piling and merging.
License:	GPL (>= 2)
Imports:	Rcpp (>= 0.12.4)
LinkingTo:	Rcpp
Suggests:	knitr, rmarkdown
VignetteBuilder:	knitr
RoxygenNote:	7.3.1

Index of help topics:

IntervalSurgeon-package                                     Operating on Integer-Bounded Intervals
annotate                                                    Annotate one set of intervals with the names of those which intersect with the other
breaks                                                      Get break points for set of intervals
depth                                                       Depth of piled intervals
detached_sorted_nonempty                                    Check intervals are detached, sorted and non-empty.
flatten                                                     Flatten a set of intervals
intersected                                                 Determine whether each interval in a given set are intersected/covered by intervals in another set
join                                                        Get all overlapping tuples of intervals from multiple sets
overlaps                                                    Compute overlaps of two sets of detached and sorted intervals
pile                                                        Get IDs of intervals covering each sub-interval
proportion_overlap                                          Calculate proportion overlapping of intersecting intervals
sections                                                    Get the sections from a set of interval breaks
stitch                                                      Stich together touching intervals and remove empty intervals

IntervalSurgeon presents functions for manipulating integer-bounded sets of intervals. Sets of intervals are represented by two-column matrices, where inclusive start points are stored in the first column, and exclusive end points in the second. A central concept in the package is the ‘sections’ of a set of intervals x: the non-overlapping, completely-covering set of intervals on the range of x, formed by making intervals between the consecutive sorted start/end points of the intevals in x. The function sections returns such a set of intervals given an input set.

Author(s)

Daniel Greene

Maintainer: Daniel Greene <[e-mail]>