qs_save

Saves an object to disk using the qs2 format.

qs_save(object, file,
         compress_level = qopt("compress_level"),
         shuffle = qopt("shuffle"),
         nthreads = qopt("nthreads"))

Arguments

object

The object to save.

file

The file name/path.

compress_level

The compression level used (default: qopt("compress_level"), 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 (default: qopt("shuffle"), initial value is TRUE).

nthreads

The number of threads to use when compressing data (default: qopt("nthreads"), initial value is 1L.

Value

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

Examples

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