altrep-api: ALTREP API

In Jiefei-Wang/AltWrapper: Create an ALTREP object by defining ALTREP functions in R

Description

Get / Set data1 or data2 from an ALTREP object. The Get function will return NULL if the object is not an ALTREP. These are native ALTREP APIs, it is not recommended to call these functions to modify an altWrapper object.

Usage

.getAltData1(x)

.getAltData2(x)

.setAltData1(x, value)

.setAltData2(x, value)

Arguments

x	An ALTREP object
value	The data that will be set to an ALTREP object

Value

.getAltData1 : An R object in data1 slot of the ALTREP

.getAltData2 : An R object in data2 slot of the ALTREP

.setAltData1 : TRUE if the value has been set or FALSE if the object is not an ALTREP

.setAltData2 : TRUE if the value has been set or FALSE if the object is not an ALTREP

Examples

## A compact sequence is an ALTREP,
## so ALTREP API can get the data that supports the compact sequence.
## The data is for developer only and not supposed to be used by users.
x = 1:10
.getAltData1(x)
.getAltData1(x)

Jiefei-Wang/AltWrapper documentation built on Oct. 30, 2019, 7:43 p.m.