Add registerDoFuture(flavor = "%dofuture%")

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: doFuture
-Version: 1.0.2-9001
+Version: 1.0.2-9002
 Title: Use Foreach to Parallelize via the Future Framework
 Depends:
     foreach (>= 1.5.0),

NEWS.md

@@ -1,6 +1,19 @@
-# Version 1.0.2-9000 (2025-03-15)
+# Version 1.0.2-9001 (2025-04-30)
 
- * ...
+## New Features
+
+ * Add `registerDoFuture(flavor = "%dofuture%")`, which makes the
+  `%dopar%` infix operator behave as if `%dofuture%` would have been
+  used. This makes it possible for you to use `%dofuture%`, even if
+  you do not have the option to update the code that uses
+  `%dopar%`. For instance, if you use a package that uses
+  `foreach(...) %dopar% { ... }` internally, this flavor allows you to
+  effectively make that the same as `foreach(...) %dofuture% { ... }`.
+  This is particularly useful if you suspect that the code does not
+  account for random number generation (RNG), where it ideally should
+  use `%dorng%` of the **doRNG** package instead of `%dopar%`. Using
+  `%dofuture%` resolves such issues, because it will use a proper
+  parallel RNG set by the futureverse ecosystem.
 
 
 # Version 1.0.2 (2025-03-15)

R/registerDoFuture.R

@@ -1,5 +1,10 @@
 #' Use the Foreach `%dopar%` Adapter with Futures
 #'
+#' @param flavor Control how the adapter should behave.
+#' If `"%dopar%"`, it behaves as a classical foreach adapter.
+#' If `"%dofuture%"`, it behaves as if `%dofuture%` would have
+#' been used instead of `%dopar%`.
+#' 
 #' The `registerDoFuture()` function makes the
 #' \code{\link[foreach:\%dopar\%]{\%dopar\%}} operator of the
 #' \pkg{foreach} package to process foreach iterations via any of
@@ -189,10 +194,22 @@
 #' @importFrom utils packageVersion
 #' @export
 #' @keywords utilities
-registerDoFuture <- function() {  #nolint
+registerDoFuture <- function(flavor = c("%dopar%", "%dofuture%")) {  #nolint
+  flavor <- match.arg(flavor, several.ok = FALSE)
+
+  if (flavor == "%dopar%") {
+    name <- "doFuture"
+    doFcn <- doFuture
+  } else if (flavor == "%dofuture%") {
+    name <- "doFuture2"
+    doFcn <- function(obj, expr, envir, data) {
+      doFuture2(obj, expr = expr, envir = envir, data = NULL)
+    }
+  }
+
   info <- function(data, item) {
     switch(item,
-      name = "doFuture",
+      name = name,
       version = packageVersion("doFuture"),
       workers = nbrOfWorkers(),
     )
@@ -217,7 +234,7 @@ registerDoFuture <- function() {  #nolint
   ## is supported. /HB 2020-12-28
   oldDoPar <- .getDoPar()
 
-  setDoPar(doFuture, info = info)
+  setDoPar(doFcn, info = info)
 
   invisible(oldDoPar)
 }

man/doFuture.options.Rd

@@ -0,0 +1,37 @@
+source("incl/start.R")
+
+strategies <- future:::supportedStrategies()
+strategies <- setdiff(strategies, "multiprocess")
+
+message("*** registerDoFuture(flavor = \"%dofuture%\") - reproducibility ...")
+
+registerDoFuture(flavor = "%dofuture%")
+
+res0 <- NULL
+
+for (strategy in strategies) {
+  message(sprintf("- plan('%s') ...", strategy))
+  plan(strategy)
+
+  mu <- 1.0
+  sigma <- 2.0
+  res <- foreach(i = 1:3, .options.future = list(packages = "stats")) %dopar% {
+    dnorm(i, mean = mu, sd = sigma)
+  }
+  print(res)
+
+  if (is.null(res0)) {
+    res0 <- res
+  } else {
+    stopifnot(all.equal(res, res0))
+  }
+
+  # Shutdown current plan
+  plan(sequential)
+
+  message(sprintf("- plan('%s') ... DONE", strategy))
+} ## for (strategy ...)
+
+message("*** registerDoFuture(flavor = \"%dofuture%\") - reproducibility ... DONE")
+
+source("incl/end.R")