R/ClusterFuture-class.R
, R/MultisessionFuture-class.R
ClusterFuture-class.Rd
A cluster future is a future whose value will be resolved asynchronously in a parallel process
ClusterFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
persistent = FALSE,
workers = NULL,
...
)
MultisessionFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
persistent = FALSE,
workers = NULL,
...
)
An R expression.
If TRUE, argument expr
is
substitute()
:ed, otherwise not.
The environment from where global objects should be identified.
If FALSE, the evaluation environment is cleared from objects prior to the evaluation of the future.
A cluster
object,
a character vector of host names, a positive numeric scalar,
or a function.
If a character vector or a numeric scalar, a cluster
object
is created using makeClusterPSOCK(workers)
.
If a function, it is called without arguments when the future
is created and its value is used to configure the workers.
The function should return any of the above types.
Additional named elements passed to Future()
.
ClusterFuture()
returns an object of class ClusterFuture
.
MultisessionFuture()
returns an object of class MultisessionFuture
,
which inherits from ClusterFuture
.
To use 'cluster' futures, use plan(cluster, ...)
, cf. cluster.
To use 'multisession' futures, use plan(multisession, ...)
, cf. multisession.