qs2 (version 0.1.5)

qd_save: qd_save

Description

Saves an object to disk using the qdata format.

Usage

qd_save(object, file,
         compress_level = qopt("compress_level"),
         shuffle = qopt("shuffle"),
         warn_unsupported_types = qopt("warn_unsupported_types"),
         nthreads = qopt("nthreads"))

Value

No value is returned. The file is written to disk.

Arguments

object

The object to save.

file

The file name/path.

compress_level

The compression level used (the initial value is 3L).

The maximum and minimum possible values depend on the version of the ZSTD library used. As of ZSTD 1.5.6 the maximum compression level is 22, and the minimum is -131072. Usually, values in the low positive range offer very good performance in terms of speed and compression.

shuffle

Whether to allow byte shuffling when compressing data (the initial value is TRUE).

warn_unsupported_types

Whether to warn when saving an object with an unsupported type (the initial value is TRUE).

nthreads

The number of threads to use when compressing data (the initial value is 1L).

Examples

x <- data.frame(int = sample(1e3, replace=TRUE),
         num = rnorm(1e3),
         char = sample(state.name, 1e3, replace=TRUE),
         stringsAsFactors = FALSE)
myfile <- tempfile()
qd_save(x, myfile)
x2 <- qd_read(myfile)
identical(x, x2) # returns TRUE