.

Author: traversc

ChangeLog

@@ -1,4 +1,10 @@
-Version 0.1.5
+Version 0.1.6 (2025-11-19)
+    * Minor fix: for complex vectors with attributes header was written twice in `qd_save`
+    * Minor fix: for non-UTF8 environments and non-ascii strings and using `stringfish` ALTREP, `qd_save` was not correctly translating to UTF8
+    * Add zstd file utilities `zstd_compress_file` and `zstd_decompress_file`
+    * Add `tests/utility_testing.R` to test additional utility functions
+
+Version 0.1.5 (2025-03-07)
     * Fix `_u8` literal operator to align with C++23 (-Wdeprecated-literal-operator)
     * Add global parameters for serialization arguments, see `Global Options for qs2` in the README / vignette
 

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: qs2
 Type: Package
 Title: Efficient Serialization of R Objects
-Version: 0.1.5
-Date: 2025-3-6
+Version: 0.1.6
+Date: 2025-11-19
 Authors@R: c(
     person("Travers", "Ching", email = "traversc@gmail.com", role = c("aut", "cre", "cph")),
     person("Yann", "Collet", role = c("ctb", "cph"), comment = "Yann Collet is the author of the bundled zstd"),
@@ -24,7 +24,7 @@ Suggests: knitr, rmarkdown, dplyr, data.table, stringi
 SystemRequirements: GNU make
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3
 VignetteBuilder: knitr
 Copyright: This package includes code from the 'zstd' library owned by Facebook, Inc. and created by Yann Collet; and code derived from the 'Blosc' library created and owned by Francesc Alted.  
 URL: https://github.com/qsbase/qs2

Makefile

@@ -53,6 +53,24 @@ install:
 	R CMD build . # --no-build-vignettes
 	R CMD INSTALL $(BUILD) --configure-args="--with-simd=AVX2 --with-TBB"
 
+install-arm:
+	find . -type f -exec chmod 644 {} \;
+	find . -type d -exec chmod 755 {} \;
+	chmod 755 cleanup
+	chmod 755 configure
+	# find src/ -type f -exec chmod 644 {} \;
+	# chmod 644 ChangeLog DESCRIPTION Makefile NAMESPACE README.md
+	./configure
+	./cleanup
+	Rscript -e "library(Rcpp); compileAttributes('.');"
+	Rscript -e "devtools::load_all(); roxygen2::roxygenise('.');"
+	find . -iname "*.a" -exec rm {} \;
+	find . -iname "*.o" -exec rm {} \;
+	find . -iname "*.so" -exec rm {} \;
+	R CMD build . # --no-build-vignettes
+	R CMD INSTALL $(BUILD) --configure-args="--with-TBB"
+
+
 install-compile-zstd:
 	find . -type f -exec chmod 644 {} \;
 	find . -type d -exec chmod 755 {} \;
@@ -96,3 +114,4 @@ vignette:
 test:
 	Rscript tests/qs_savem_testing.R
 	QS_EXTENDED_TESTS=1 Rscript tests/correctness_testing.R; unset QS_EXTENDED_TESTS
+	Rscript tests/utility_testing.R

NAMESPACE

@@ -12,15 +12,18 @@ export(qx_dump)
 
 export(qopt)
 
-export("qs_to_rds")
-export("rds_to_qs")
+export(qs_to_rds)
+export(rds_to_qs)
 
-export("zstd_compress_raw")
-export("zstd_decompress_raw")
-export("zstd_compress_bound")
-export("blosc_shuffle_raw")
-export("blosc_unshuffle_raw")
-export("xxhash_raw")
+export(zstd_compress_file)
+export(zstd_decompress_file)
+
+export(zstd_compress_raw)
+export(zstd_decompress_raw)
+export(zstd_compress_bound)
+export(blosc_shuffle_raw)
+export(blosc_unshuffle_raw)
+export(xxhash_raw)
 
 export(base85_decode)
 export(base85_encode)
@@ -32,4 +35,4 @@ export(encode_source)
 
 import(stringfish)
 importFrom(Rcpp,evalCpp)
-useDynLib(qs2, .registration = TRUE)
+useDynLib(qs2, .registration = TRUE)

R/RcppExports.R

@@ -145,3 +145,11 @@ c_base91_decode <- function(encoded_string) {
     .Call(`_qs2_c_base91_decode`, encoded_string)
 }
 
+zstd_compress_file <- function(input_file, output_file, compress_level = qopt("compress_level")) {
+    invisible(.Call(`_qs2_zstd_compress_file`, input_file, output_file, compress_level))
+}
+
+zstd_decompress_file <- function(input_file, output_file) {
+    invisible(.Call(`_qs2_zstd_decompress_file`, input_file, output_file))
+}
+

R/zstd_file_functions.R

@@ -0,0 +1,44 @@
+#' Zstd file compression
+#'
+#' A utility function to compresses a file with zstd.
+#'
+#' @usage zstd_compress_file(input_file, output_file, compress_level = qopt("compress_level"))
+#'
+#' @param input_file Path to the file to compress.
+#' @param output_file Path for the compressed file.
+#' @param compress_level The compression level used.
+#'
+#' @return No value is returned. The file is written to disk.
+#' @export
+#' @name zstd_compress_file
+#'
+#' @examples
+#' infile <- tempfile()
+#' writeBin(as.raw(1:5), infile)
+#' outfile <- tempfile()
+#' zstd_compress_file(infile, outfile, compress_level = 1)
+#' stopifnot(file.exists(outfile))
+NULL
+
+#' Zstd file decompression
+#'
+#' A utility function to decompresses a zstd file to disk.
+#'
+#' @usage zstd_decompress_file(input_file, output_file)
+#' 
+#' @param input_file Path to the zstd file.
+#' @param output_file Path for the decompressed file.
+#' 
+#' @return No value is returned. The file is written to disk.
+#' @export
+#' @name zstd_decompress_file
+#' 
+#' @examples
+#' infile <- tempfile()
+#' writeBin(as.raw(1:5), infile)
+#' zfile <- tempfile()
+#' zstd_compress_file(infile, zfile, compress_level = 1)
+#' outfile <- tempfile()
+#' zstd_decompress_file(zfile, outfile)
+#' stopifnot(identical(readBin(infile, what = "raw", n = 5), readBin(outfile, what = "raw", n = 5)))
+NULL