A batchtools local future is an synchronous uniprocess future that will be evaluated in a background R session. A batchtools interactive future is an synchronous uniprocess future that will be evaluated in the current R session (and variables will be assigned to the calling environment rather than to a local one). Both types of futures will block until the futures are resolved.
batchtools_local( expr, envir = parent.frame(), substitute = TRUE, globals = TRUE, label = NULL, workers = 1L, registry = list(), ... )
The R expression to be evaluated
The environment in which global environment should be located.
(optional) a logical, a character vector, a named list, or a
Globals object. If TRUE, globals are identified by code
inspection based on
(optional) Label of the future (where applicable, becomes the job name for most job schedulers).
(optional) The maximum number of workers the batchtools
backend may use at any time. Interactive and "local" backends can only
process one future at the time (
(optional) A named list of settings to control the setup of the batchtools registry.
Additional arguments passed to
An object of class
batchtools local futures rely on the batchtools backend set up by
batchtools::makeClusterFunctionsInteractive(external = TRUE)
and batchtools interactive futures on the one set up by
These are supported by all operating systems.
An alternative to batchtools interactive futures is to use transparent futures of the future package.