IRangesList-class          package:IRanges          R Documentation

List of IRanges and NormalIRanges

Description:

     'IRangesList' and 'NormalIRangesList' objects for storing
     'IRanges' and 'NormalIRanges' objects respectively.

Constructor:


      'IRangesList(..., universe = NULL, compress = TRUE)': The '...'
          argument accepts either a comma-separated list of 'IRanges'
          objects, or a single 'LogicalList' / logical 'RleList'
          object, or 2 elements named 'start' and 'end' each of them
          being either a list of integer vectors or an IntegerList
          object. When 'IRanges' objects are supplied, each of them
          becomes an element in the new 'IRangesList', in the same
          order, which is analogous to the 'list' constructor. If
          'compress', the internal storage of the data is compressed.


Coercion:


      'unlist(x)': Unlists 'x', an 'IRangesList', by concatenating all
          of the ranges into a single 'IRanges' instance. If the length
          of 'x' is zero, an empty 'IRanges' is returned.


Methods for NormalIRangesList objects:


      'max(x)': An integer vector containing the maximum values of each
          of the elements of 'x'.

      'min(x)': An integer vector containing the minimum values of each
          of the elements of 'x'.


Author(s):

     Michael Lawrence

See Also:

     'RangesList', the parent of this class, for more functionality.

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)

