IRangesList-class {IRanges} | R Documentation |
List of IRanges and NormalIRanges
Description
IRangesList
and
NormalIRangesList
objects for storing
IRanges
and NormalIRanges
objects
respectively.
Constructor
IRangesList(..., compress=TRUE)
: The...
argument accepts either a comma-separated list ofIRanges
objects, or a singleLogicalList
/ logicalRleList
object, or 2 elements namedstart
andend
each of them being either a list of integer vectors or an IntegerList object. WhenIRanges
objects are supplied, each of them becomes an element in the newIRangesList
, in the same order, which is analogous to thelist
constructor. Ifcompress
, the internal storage of the data is compressed.
Coercion
In the code snippets below, from
is a list-like object.
as(from, "SimpleIRangesList")
: Coercesfrom
, to aSimpleIRangesList
, requiring that allIntegerRanges
elements are coerced to internalIRanges
elements. This is a convenient way to ensure that allIntegerRanges
have been imported into R (and that there is no unwanted overhead when accessing them).as(from, "CompressedIRangesList")
: Coercesfrom
, to aCompressedIRangesList
, requiring that allIntegerRanges
elements are coerced to internalIRanges
elements. This is a convenient way to ensure that allIntegerRanges
have been imported into R (and that there is no unwanted overhead when accessing them).as(from, "SimpleNormalIRangesList")
: Coercesfrom
, to aSimpleNormalIRangesList
, requiring that allIntegerRanges
elements are coerced to internalNormalIRanges
elements.as(from, "CompressedNormalIRangesList")
: Coercesfrom
, to aCompressedNormalIRangesList
, requiring that allIntegerRanges
elements are coerced to internalNormalIRanges
elements.
In the code snippet below, x
is an IRangesList
object.
unlist(x)
: Unlistsx
, anIRangesList
, by concatenating all of the ranges into a singleIRanges
instance. If the length ofx
is zero, an emptyIRanges
is returned.
Methods for NormalIRangesList objects
-
max(x)
: An integer vector containing the maximum values of each of the elements ofx
. -
min(x)
: An integer vector containing the minimum values of each of the elements ofx
.
Author(s)
Michael Lawrence and Hervé Pagès
See Also
-
IntegerRangesList
, the parent of this class, for more functionality. -
intra-range-methods and inter-range-methods for intra range and inter range transformations.
-
setops-methods for set operations on IRangesList objects.
Examples
range1 <- IRanges(start=c(1,2,3), end=c(5,2,8))
range2 <- IRanges(start=c(15,45,20,1), end=c(15,100,80,5))
named <- IRangesList(one = range1, two = range2)
length(named) # 2
names(named) # "one" and "two"
named[[1]] # range1
unnamed <- IRangesList(range1, range2)
names(unnamed) # NULL
x <- IRangesList(start=list(c(1,2,3), c(15,45,20,1)),
end=list(c(5,2,8), c(15,100,80,5)))
as.list(x)