DelayedDataFrame-class: DelayedDataFrame-class

Description Usage Arguments Details Value Examples

Description

The DelayedDataFrame class extends the DataFrame class and supports the storage of any type of object (with ‘length’ and ‘[’ methods) as columns.

the lazyIndex slot getter and setter for DelayedDataFrame object.

the coercion method between DataFrame and DelayedDataFrame objects.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
DelayedDataFrame(..., row.names = NULL, check.names = TRUE)

## S4 method for signature 'DelayedDataFrame'
lazyIndex(x)

.from_DataFrame_to_DelayedDataFrame(from)

.from_DelayedDataFrame_to_DFrame(from, to = "DFrame", strict = TRUE)

lazyIndex(x) <- value

## S4 replacement method for signature 'DelayedDataFrame'
lazyIndex(x) <- value

Arguments

...

the arguments to pass into construction of a new DelayedDataFrame.

row.names

the rownames for the newly constructed DelayedDataFrame object.

check.names

logical. If ‘TRUE’ then the names of the variables in the DelayedDataFrame are checked to ensure that they are syntactically valid variable names and are not duplicated. If necessary they are adjusted (by ‘make.names’) so that they are.

x

the DelayedDataFrame object.

from

the object to be converted.

to

the class of object to be returned by coercion.

strict

Logical. Whether to force return a DataFrame.

value

the new value of lazyIndex slot for DelayedDataFrame object.

Details

The DelayedDataFrame inherits from DataFrame and behaves very similarily in terms of construction, subsetting, splitting, combining, etc. The most notable exception is that The additional slot of lazyIndex, enables DelayedArray (with different back-ends) columns to share indexes when possible.

Please be very careful to use this replace method for lazyIndex slot. Because it only replace the lazyIndex slot, but not necessarily the nrow and rownames slots. If you want to have synchronized subsetting for all slots, the [ method should be used.

Value

lazyIndex<-: the DelayedDataFrame object with new value of lazyIndex slot.

Examples

1
2
3
4
5
DDF <- DelayedDataFrame(letters, LETTERS)
DDF1 <- DDF[1:10,]
DDF1
lazyIndex(DDF1)
as(DDF1, "DataFrame")

Bioconductor/DelayedDataFrame documentation built on April 30, 2020, 2:19 a.m.