Skip to contents

qs2 Option Getter/Setter

Source: R/qopt.R
qopt.Rd

Get or set a global qs2 option.

Usage

qopt(parameter, value = NULL)

Arguments

parameter

A character string specifying the option to access. Must be one of "compress_level", "shuffle", "nthreads", "validate_checksum", "warn_unsupported_types", or "use_alt_rep".

value

If NULL (the default), the current value is retrieved. Otherwise, the global option is set to value.

Value

If value is NULL, returns the current value of the specified option. Otherwise, sets the option and returns the new value invisibly.

Details

This function provides an interface to retrieve or update internal qs2 options such as compression level, shuffle flag, number of threads, checksum validation, warning for unsupported types, and requested ALTREP usage. It directly calls the underlying C-level functions.

The default settings are:

  • compress_level: 3L

  • shuffle: TRUE

  • nthreads: 1L

  • validate_checksum: FALSE

  • warn_unsupported_types: TRUE (used only in qd_save)

  • use_alt_rep: FALSE (accepted by qd_read and qd_deserialize, but temporarily disabled)

When parameter = "use_alt_rep" is set to TRUE, qdata reads currently warn and fall back to ordinary character vectors.

When value is NULL, the current value of the specified option is returned. Otherwise, the option is set to value and the new value is returned invisibly.

Examples

# Get the current compression level:
qopt("compress_level")
#> [1] 3

# Set the compression level to 5:
qopt("compress_level", value = 5)

# Get the current shuffle setting:
qopt("shuffle")
#> [1] TRUE

# Get the current setting for warn_unsupported_types (used in qd_save):
qopt("warn_unsupported_types")
#> [1] TRUE

# Get the current setting for use_alt_rep:
qopt("use_alt_rep")
#> [1] FALSE