doFuture (version 1.1.3)

with.DoPar: Evaluate an Expression using a Temporarily Registered Foreach %dopar% Adapter

Description

Evaluate an Expression using a Temporarily Registered Foreach %dopar% Adapter

Usage

# S3 method for DoPar
with(data, expr, ..., local = FALSE, envir = parent.frame())

Value

Invisibly, the value of expr if local = FALSE, other NULL.

Arguments

data

The foreach `%dopar% adapter to use temporarily.

expr

The R expression to be evaluated.

local

If TRUE, then the future plan specified by data is applied temporarily in the calling frame. Argument expr must not be specified if local = TRUE.

envir

The environment where the adapter should be set and the expression evaluated.

...

Not used.

Examples

with(registerDoFuture(), {
  y <- foreach(x = 1:3) %dopar% { x^2 }
})

a_fcn_in_a_pkg <- function(xs) {
  foreach(x = xs) %dopar% { x^2 }
}

with(registerDoFuture(flavor = "%dofuture%"), {
  y <- a_fcn_in_a_pkg(1:3)
})


my_fcn <- function(xs) {
  ## Use registerDoFuture() for this function only and then
  ## revert back to the previously set foreach adapter
  with(registerDoFuture(), local = TRUE)
  
  foreach(x = xs) %dopar% { x^2 }
}