Deprecate plan(..., earlySignal = ...)

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future
-Version: 1.68.0-9020
+Version: 1.68.0-9021
 Title: Unified Parallel and Distributed Processing in R for Everyone
 Depends:
     R (>= 3.2.0)

NEWS.md

@@ -27,6 +27,9 @@
    deprecation warnings. Deprecated also hidden argument 'local',
    which was been there for legacy reasons.
 
+ * Use of `plan(..., earlySignal = ...)` is now defunct and produces a
+   deprecation warning.
+
  * The `cluster` backend now defaults to `earlySignal = FALSE`. This
    was effectively already the case, because of an internal thinko
    bug.

R/009.deprecation.R

@@ -4,6 +4,16 @@ deprecateFutureArgument <- function(name, value) {
   action <- match.arg(action, choices = c("deprecated", "defunct", "ignore"))
   if (action == "ignore") return()
   dfcn <- if (action == "deprecated") .Deprecated else .Defunct
-  dfcn(msg = sprintf("future() no longer takes argument '%s'. Attempts to use it is ignored, but will eventually become an error: %s = %s", name, name, deparse(value)[1]))
+  dfcn(msg = sprintf("future::future() no longer takes argument '%s'. Attempts to use will eventually be ignored and then become an error: %s = %s", name, name, deparse(value)[1]))
+}
+
+
+deprecatePlanArgument <- function(name, value) {
+  option <- sprintf("future.plan.%s", name)
+  action <- getOption(option, "deprecated")
+  action <- match.arg(action, choices = c("deprecated", "defunct", "ignore"))
+  if (action == "ignore") return()
+  dfcn <- if (action == "deprecated") .Deprecated else .Defunct
+  dfcn(msg = sprintf("future::plan() no longer takes argument '%s'. Attempts to use will eventually be ignored and then become an error: %s = %s", name, name, deparse(value)[1]))
 }
 

R/utils-options.R

@@ -470,4 +470,5 @@ update_package_options <- function(debug = FALSE) {
   update_package_option("future.future.earlySignal", mode = "character", debug = debug)
   update_package_option("future.future.gc", mode = "character", debug = debug)
   update_package_option("future.future.local", mode = "character", debug = debug)
+  update_package_option("future.plan.earlySignal", mode = "character", debug = debug)
 }

R/utils_api-tweak.R

@@ -108,7 +108,12 @@ tweak.future <- function(strategy, ..., penvir = parent.frame()) {
     stopf("Detected arguments that must not be set via plan() or tweak(): %s",
          untweakable)
   }
-  
+
+  ## Arguments 'earlySignal' is deprecated
+  if ("earlySignal" %in% names) {
+    deprecatePlanArgument("earlySignal", args[["earlySignal"]])
+  }
+
   ## formals()<- drops any attributes including class
   attrs <- attributes(strategy)
   class <- class(strategy)