matter-options {matter} | R Documentation

## Options for “matter” Objects

### Description

The `matter` package provides the following options:

- `options(matter.cast.warning=TRUE)`:Should a warning be emitted when casting between data types results in a loss of precision?

- `options(matter.default.chunksize=1000000L)`:The default chunksize for new `matter` objects. This is the (suggested) maximum number of elements which should be accessed at once by summary functions and linear algebra. Ignored when explicitly subsetting the dataset. Must be an integer.

- `options(matter.show.head=TRUE)`:Should a preview of the beginning of the data be displayed when the object is printed?

- `options(matter.show.head.n=6)`:The number of elements, rows, and/or columns to be displayed by the object preview.

- `options(matter.coerce.altrep=FALSE)`:When coercing `matter` objects to native R objects (such as `matrix`), should a `matter`-backed ALTREP object be returned instead? The initial coercion will be cheap, and the result will look like a native R object. This does not guarantee that the full data is never read into memory. Not all functions are ALTREP-aware at the C-level, so some operations may still trigger the full data to be read into memory. This should only ever happen once, as long as the object is not duplicated, though.

- `options(matter.coerce.altrep.list=FALSE)`:Should a `matter`-backed ALTREP list be returned when coercing `matter_list` lists to native R lists? Lists are treated differently, because the coercion is more costly, as the metadata for each list element must be uncompressed and converted to separate ALTREP representations. (Note that this does not affect `matter_df` data frames, which do not compress metadata about the columns, because the columns are regular `matter` vectors.)

- `options(matter.wrap.altrep=FALSE)`:When coercing to a `matter`-backed ALTREP object, should the object be wrapped in an ALTREP wrapper? (This is always done in cases where the coercion preserves existing attributes.) This allows setting of attributes without triggering a (potentially expensive) duplication of the object when safe to do so.

- `options(matter.dump.dir=tempdir())`:Temporary directory where `matter` object files should be dumped when created without user-specified file paths.

[Package matter version 1.20.0 Index]