Add compression option for non-memory caches

Fixes #71

DESCRIPTION

@@ -21,4 +21,4 @@ Suggests:
     covr,
     googleCloudStorageR
 License: MIT + file LICENSE
-RoxygenNote: 6.0.1
+RoxygenNote: 6.1.0

NEWS.md

@@ -2,6 +2,7 @@
 * Name clashes between function arguments and variables defined when memoising
   no longer occur (#43, @egnha).
 * Add Google Cloud Storage support via `cache_gcs()` (#59 - @MarkEdmondson1234)
+* Add `compress` option for non-memory caches (#71 - @coolbutuseless)
 
 # Version 1.1.0
 * Caches now hash the function body along with the arguments, to ensure

R/cache_filesystem.R

@@ -3,6 +3,8 @@
 #' Use a cache on the local filesystem that will persist between R sessions.
 #'
 #' @param path Directory in which to store cached items.
+#' @param compress Argument passed to \code{saveRDS}. One of FALSE, "gzip",
+#' "bzip2" or "xz". Default: FALSE.
 #'
 #' @examples
 #'
@@ -23,7 +25,7 @@
 #'
 #' @export
 #' @inheritParams cache_memory
-cache_filesystem <- function(path, algo = "xxhash64") {
+cache_filesystem <- function(path, algo = "xxhash64", compress = FALSE) {
 
   if (!dir.exists(path)) {
     dir.create(path, showWarnings = FALSE)
@@ -35,7 +37,7 @@ cache_filesystem <- function(path, algo = "xxhash64") {
   }
 
   cache_set <- function(key, value) {
-    saveRDS(value, file = file.path(path, key))
+    saveRDS(value, file = file.path(path, key), compress = compress)
   }
 
   cache_get <- function(key) {

R/cache_gcs.R

@@ -15,10 +15,12 @@
 #'
 #'
 #' @param cache_name Bucket name for storing cache files.
+#' @param compress Argument passed to \code{saveRDS}. One of FALSE, "gzip",
+#' "bzip2" or "xz". Default: FALSE.
 #' @inheritParams cache_memory
 #' @export
 cache_gcs <- function(cache_name = googleCloudStorageR::gcs_get_global_bucket(),
-                      algo = "sha512") {
+                      algo = "sha512", compress = FALSE) {
 
   if (!(requireNamespace("googleCloudStorageR"))) { stop("Package `googleCloudStorageR` must be installed for `cache_gcs()`.") } # nocov
 
@@ -33,7 +35,7 @@ cache_gcs <- function(cache_name = googleCloudStorageR::gcs_get_global_bucket(),
   cache_set <- function(key, value) {
     temp_file <- file.path(path, key)
     on.exit(unlink(temp_file))
-    saveRDS(value, file = temp_file)
+    saveRDS(value, file = temp_file, compress = compress)
     suppressMessages(
       googleCloudStorageR::gcs_upload(temp_file, name = key, bucket = cache_name)
     )

R/cache_s3.R

@@ -15,10 +15,12 @@
 #'
 #'
 #' @param cache_name Bucket name for storing cache files.
+#' @param compress Argument passed to \code{saveRDS}. One of FALSE, "gzip",
+#' "bzip2" or "xz". Default: FALSE.
 #' @inheritParams cache_memory
 #' @export
 
-cache_s3 <- function(cache_name, algo = "sha512") {
+cache_s3 <- function(cache_name, algo = "sha512", compress = FALSE) {
 
   if (!(requireNamespace("aws.s3"))) { stop("Package `aws.s3` must be installed for `cache_s3()`.") } # nocov
 
@@ -37,7 +39,7 @@ cache_s3 <- function(cache_name, algo = "sha512") {
   cache_set <- function(key, value) {
     temp_file <- file.path(path, key)
     on.exit(unlink(temp_file))
-    saveRDS(value, file = temp_file)
+    saveRDS(value, file = temp_file, compress = compress)
     aws.s3::put_object(temp_file, object = key, bucket = cache_name)
   }