Function reference • altrepr

Common ALTREP Utilities

is_altrep(): Checks if an R object is ALTREP

alt_details(): Returns a summary of the properties of an ALTREP object

General ALTREP Utilities

alt_class(): Gets the altrep class of an object.

alt_classname(): Gets the name of the altrep class of an object

alt_data1(): Gets the first altrep data slot

alt_data2(): Gets the second altrep data slot.

alt_inspect(): Inspects an R data structure

alt_pkgname(): Gets the package in which an ALTREP class was defined

alt_type(): Gets the name of the type that this ALTREP is representing.

Compact Sequence Utilities

compact_details(): Returns a list containing the fields of a compact vector

compact_expand(): Forces a compact vector into extended form

compact_is_expanded(): Checks if a compact vector has been expanded

compact_to_standard(): Returns a non-ALTREP copy of a compact vector

is_compact_vec(): Checks for compact sequence ALTREPs

Deferred String Utilities

deferred_expand(): Forces a deferred string into extended form

deferred_is_expanded(): Checks is a deferred string has been expanded

is_deferred_string(): Checks for deferred string ALTREPs

Wrapper Object Utilities

is_wrapper(): Checks for wrapper object ALTREPs

wrapper_details(): Returns a list containing the fields of a wrapper object

wrapper_make(): Makes a custom wrapper ALTREP

Memmap Object Utilities

is_mmap(): Checks for memmap vector ALTREPs

mmap_details(): Returns a list containing the fields of a memory mapped vector

mmap_make(): Makes a memory-mapped vector

Advanced/Dangerous Functions

alt_touch_dataptr(): Touches the DATAPTR of a vector

set_alt_data1(): Sets the data1 value of an ALTREP

set_alt_data2(): Sets the data2 value of an ALTREP