update change log

Author: traversc

ChangeLog

@@ -1,7 +1,7 @@
 Version 0.1.5
-    * Add global parameters for serialization arguments
+    * Add global parameters for serialization arguments, see `Global Options for qs2` in the README / vignette
 
-Version 0.1.4
+Version 0.1.4 (2024-12-12)
     * Fix for decompression error edge case (https://github.com/qsbase/qs2/issues/7)
 
 Version 0.1.3 (2024-12-02)

R/RcppExports.R

@@ -1,11 +1,11 @@
 # Generated by using Rcpp::compileAttributes() -> do not edit by hand
 # Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
 
-qs_save <- function(object, file, compress_level = getOption("qs2.compress_level", 1L), shuffle = getOption("qs2.shuffle", TRUE), nthreads = getOption("qs2.nthreads", 1L)) {
+qs_save <- function(object, file, compress_level = getOption("qs2.compress_level", 3L), shuffle = getOption("qs2.shuffle", TRUE), nthreads = getOption("qs2.nthreads", 1L)) {
     invisible(.Call(`_qs2_qs_save`, object, file, compress_level, shuffle, nthreads))
 }
 
-qs_serialize <- function(object, compress_level = getOption("qs2.compress_level", 1L), shuffle = getOption("qs2.shuffle", TRUE), nthreads = getOption("qs2.nthreads", 1L)) {
+qs_serialize <- function(object, compress_level = getOption("qs2.compress_level", 3L), shuffle = getOption("qs2.shuffle", TRUE), nthreads = getOption("qs2.nthreads", 1L)) {
     invisible(.Call(`_qs2_qs_serialize`, object, compress_level, shuffle, nthreads))
 }
 
@@ -17,11 +17,11 @@ qs_deserialize <- function(input, validate_checksum = getOption("qs2.validate_ch
     .Call(`_qs2_qs_deserialize`, input, validate_checksum, nthreads)
 }
 
-qd_save <- function(object, file, compress_level = getOption("qs2.compress_level", 1L), shuffle = getOption("qs2.shuffle", TRUE), warn_unsupported_types = getOption("qs2.warn_unsupported_types", TRUE), nthreads = getOption("qs2.nthreads", 1L)) {
+qd_save <- function(object, file, compress_level = getOption("qs2.compress_level", 3L), shuffle = getOption("qs2.shuffle", TRUE), warn_unsupported_types = getOption("qs2.warn_unsupported_types", TRUE), nthreads = getOption("qs2.nthreads", 1L)) {
     invisible(.Call(`_qs2_qd_save`, object, file, compress_level, shuffle, warn_unsupported_types, nthreads))
 }
 
-qd_serialize <- function(object, compress_level = getOption("qs2.compress_level", 1L), shuffle = getOption("qs2.shuffle", TRUE), warn_unsupported_types = getOption("qs2.warn_unsupported_types", TRUE), nthreads = getOption("qs2.nthreads", 1L)) {
+qd_serialize <- function(object, compress_level = getOption("qs2.compress_level", 3L), shuffle = getOption("qs2.shuffle", TRUE), warn_unsupported_types = getOption("qs2.warn_unsupported_types", TRUE), nthreads = getOption("qs2.nthreads", 1L)) {
     .Call(`_qs2_qd_serialize`, object, compress_level, shuffle, warn_unsupported_types, nthreads)
 }
 
@@ -57,7 +57,7 @@ internal_is_utf8_locale <- function(size) {
     .Call(`_qs2_internal_is_utf8_locale`, size)
 }
 
-zstd_compress_raw <- function(data, compress_level = getOption("qs2.compress_level", 1L)) {
+zstd_compress_raw <- function(data, compress_level = getOption("qs2.compress_level", 3L)) {
     .Call(`_qs2_zstd_compress_raw`, data, compress_level)
 }
 

R/qx_functions.R

@@ -1,7 +1,7 @@
 shared_params_save <- function(file_output=TRUE, warn_unsupported_types=FALSE) {
   c('@param object The object to save.',
     '@param file The file name/path.'[file_output],
-    '@param compress_level The compression level used (default: getOption("qs2.compress_level", 1L)).',
+    '@param compress_level The compression level used (default: getOption("qs2.compress_level", 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.',
@@ -27,7 +27,7 @@ shared_params_read <- function(file_input=TRUE, use_alt_rep=FALSE) {
 #' Saves an object to disk using the `qs2` format.
 #'
 #' @usage qs_save(object, file,
-#'          compress_level = getOption("qs2.compress_level", 1L),
+#'          compress_level = getOption("qs2.compress_level", 3L),
 #'          shuffle = getOption("qs2.shuffle", TRUE),
 #'          nthreads = getOption("qs2.nthreads", 1L))
 #'
@@ -52,7 +52,7 @@ NULL
 #' Serializes an object to a raw vector using the `qs2` format.
 #' 
 #' @usage qs_serialize(object,
-#'          compress_level = getOption("qs2.compress_level", 1L),
+#'          compress_level = getOption("qs2.compress_level", 3L),
 #'          shuffle = getOption("qs2.shuffle", TRUE),
 #'          nthreads = getOption("qs2.nthreads", 1L))
 #' 
@@ -123,7 +123,7 @@ NULL
 #' Saves an object to disk using the `qdata` format.
 #'
 #' @usage qd_save(object, file,
-#'          compress_level = getOption("qs2.compress_level", 1L),
+#'          compress_level = getOption("qs2.compress_level", 3L),
 #'          shuffle = getOption("qs2.shuffle", TRUE),
 #'          warn_unsupported_types = getOption("qs2.warn_unsupported_types", TRUE),
 #'          nthreads = getOption("qs2.nthreads", 1L))
@@ -149,7 +149,7 @@ NULL
 #' Serializes an object to a raw vector using the `qdata` format.
 #' 
 #' @usage qd_serialize(object,
-#'          compress_level = getOption("qs2.compress_level", 1L),
+#'          compress_level = getOption("qs2.compress_level", 3L),
 #'          shuffle = getOption("qs2.shuffle", TRUE),
 #'          warn_unsupported_types = getOption("qs2.warn_unsupported_types", TRUE),
 #'          nthreads = getOption("qs2.nthreads", 1L))
@@ -245,7 +245,7 @@ NULL
 #'
 #' Compresses to a raw vector using the zstd algorithm. Exports the main zstd compression function.
 #'
-#' @usage zstd_compress_raw(data, compress_level = getOption("qs2.compress_level", 1L))
+#' @usage zstd_compress_raw(data, compress_level = getOption("qs2.compress_level", 3L))
 #'
 #' @param data Raw vector to be compressed.
 #' @param compress_level The compression level used.

README.md

@@ -183,7 +183,7 @@ functions. You can override these defaults by setting them via R’s
 
   - **qs2.compress\_level**  
     The default compression level used when compressing data.  
-    **Default:** `1L`
+    **Default:** `3L`
 
   - **qs2.shuffle**  
     A logical flag indicating whether to allow byte shuffling during

man/qd_save.Rd

@@ -22,10 +22,10 @@
 #include "qx_dump.h"
 
 // qs2 format functions
-// [[Rcpp::export(rng = false, invisible = true, signature = {object, file, compress_level = getOption("qs2.compress_level", 1L), shuffle = getOption("qs2.shuffle", TRUE), nthreads = getOption("qs2.nthreads", 1L)})]]
+// [[Rcpp::export(rng = false, invisible = true, signature = {object, file, compress_level = getOption("qs2.compress_level", 3L), shuffle = getOption("qs2.shuffle", TRUE), nthreads = getOption("qs2.nthreads", 1L)})]]
 SEXP qs_save(SEXP object, const std::string& file, const int compress_level, const bool shuffle, const int nthreads);
 CVectorOut qs_serialize_impl(SEXP object, const int compress_level, const bool shuffle, const int nthreads);
-// [[Rcpp::export(rng = false, invisible = true, signature = {object, compress_level = getOption("qs2.compress_level", 1L), shuffle = getOption("qs2.shuffle", TRUE), nthreads = getOption("qs2.nthreads", 1L)})]]
+// [[Rcpp::export(rng = false, invisible = true, signature = {object, compress_level = getOption("qs2.compress_level", 3L), shuffle = getOption("qs2.shuffle", TRUE), nthreads = getOption("qs2.nthreads", 1L)})]]
 SEXP qs_serialize(SEXP object, const int compress_level, const bool shuffle, const int nthreads);
 unsigned char* c_qs_serialize(SEXP object, size_t* len, const int compress_level, const bool shuffle, const int nthreads);
 bool c_qs_free(void* ptr);
@@ -37,10 +37,10 @@ SEXP qs_deserialize(SEXP input, const bool validate_checksum, const int nthreads
 SEXP c_qs_deserialize(const unsigned char* buffer, const size_t len, const bool validate_checksum, const int nthreads);
 
 // qdata format functions
-// [[Rcpp::export(rng = false, invisible = true, signature = {object, file, compress_level = getOption("qs2.compress_level", 1L), shuffle = getOption("qs2.shuffle", TRUE), warn_unsupported_types = getOption("qs2.warn_unsupported_types", TRUE), nthreads = getOption("qs2.nthreads", 1L)})]]
+// [[Rcpp::export(rng = false, invisible = true, signature = {object, file, compress_level = getOption("qs2.compress_level", 3L), shuffle = getOption("qs2.shuffle", TRUE), warn_unsupported_types = getOption("qs2.warn_unsupported_types", TRUE), nthreads = getOption("qs2.nthreads", 1L)})]]
 SEXP qd_save(SEXP object, const std::string& file, const int compress_level, const bool shuffle, const bool warn_unsupported_types, const int nthreads);
 CVectorOut qd_serialize_impl(SEXP object, const int compress_level, const bool shuffle, const bool warn_unsupported_types, const int nthreads);
-// [[Rcpp::export(rng = false, signature = {object, compress_level = getOption("qs2.compress_level", 1L), shuffle = getOption("qs2.shuffle", TRUE), warn_unsupported_types = getOption("qs2.warn_unsupported_types", TRUE), nthreads = getOption("qs2.nthreads", 1L)})]]
+// [[Rcpp::export(rng = false, signature = {object, compress_level = getOption("qs2.compress_level", 3L), shuffle = getOption("qs2.shuffle", TRUE), warn_unsupported_types = getOption("qs2.warn_unsupported_types", TRUE), nthreads = getOption("qs2.nthreads", 1L)})]]
 SEXP qd_serialize(SEXP object, const int compress_level, const bool shuffle, const bool warn_unsupported_types, const int nthreads);
 unsigned char* c_qd_serialize(SEXP object, size_t* len, const int compress_level, const bool shuffle, const bool warn_unsupported_types, const int nthreads);
 bool c_qd_free(void* ptr);
@@ -66,7 +66,7 @@ int internal_set_blocksize(int size);
 int internal_is_utf8_locale(int size);
 
 // standalone utility functions
-// [[Rcpp::export(rng = false, signature = {data, compress_level = getOption("qs2.compress_level", 1L)})]]
+// [[Rcpp::export(rng = false, signature = {data, compress_level = getOption("qs2.compress_level", 3L)})]]
 std::vector<unsigned char> zstd_compress_raw(SEXP const data, int compress_level);
 // [[Rcpp::export(rng = false)]]
 RawVector zstd_decompress_raw(SEXP const data);