Add option 'future.cache.path' complementing env var 'R_FUTURE_CACHE_PATH' [#30]

Author: HenrikBengtsson

NEWS

@@ -33,6 +33,9 @@ NEW FEATURES:
    'compress'.  For example, to turn of file compression, use
    plan(batchtools_nnn, registry = list(compress = FALSE)).
 
+ * The default location of the '.future' folder can be controlled by R option
+   'future.cache.path' or environment variable 'R_FUTURE_CACHE_PATH'.
+
 DOCUMENTATION:
 
  * Add help("future.batchtools.options") which descriptions R options and

R/future_cache_path.R

@@ -3,7 +3,7 @@ future_cache_path <- local({
   ## The subfolder used for this session
   dir <- NULL
 
-  function(root_path = Sys.getenv("R_FUTURE_CACHE_PATH", ".future"), absolute = TRUE, create = TRUE) {
+  function(root_path = getOption("future.cache.path", Sys.getenv("R_FUTURE_CACHE_PATH", ".future")), absolute = TRUE, create = TRUE) {
     if (is.null(dir)) {
       id <- basename(tempdir())
       id <- gsub("Rtmp", "", id, fixed = TRUE)

R/options.R

@@ -28,14 +28,15 @@
 #'     This option controls how many lines are displayed.
 #'     (Default: `48L`)}
 #'
-#'   \item{\env{R_FUTURE_CACHE_PATH}}{(character string)
+#'   \item{\option{future.cache.path} / \env{R_FUTURE_CACHE_PATH}}{
+#'     (character string)
 #'     An absolute or relative path specifying the root folder in which
 #'     \pkg{batchtools} registry folders are stored.
 #'     (Default: `.future`)}
 #' }
 #'
 #' @aliases
-#' future.cmdargs 
+#' future.cache.path
 #' future.batchtools.expiration.tail
 #' future.batchtools.output
 #' future.batchtools.workers

R/zzz.R

@@ -1,6 +1,7 @@
 .onLoad <- function(libname, pkgname) {
   inRCmdCheck <- import_future("inRCmdCheck")
   if (inRCmdCheck()) {
+    ## Don't write to current working directory when running R CMD check.
     path <- Sys.getenv("R_FUTURE_CACHE_PATH", file.path(tempdir(), ".future"))
     Sys.setenv("R_FUTURE_CACHE_PATH" = path)
   }