ClusterFuture-class {future} | R Documentation |
A cluster future is a future whose value will be resolved asynchronously in a parallel process
ClusterFuture( expr = NULL, envir = parent.frame(), substitute = FALSE, globals = TRUE, packages = NULL, local = !persistent, gc = FALSE, persistent = FALSE, workers = NULL, user = NULL, master = NULL, revtunnel = TRUE, homogeneous = TRUE, ... ) MultisessionFuture( expr = NULL, envir = parent.frame(), substitute = FALSE, globals = TRUE, persistent = FALSE, local = !persistent, workers = NULL, ... )
expr |
An R expression. |
envir |
The environment from where global objects should be identified. |
substitute |
If TRUE, argument |
globals |
(optional) a logical, a character vector, or a named list
to control how globals are handled.
For details, see section 'Globals used by future expressions'
in the help for |
packages |
(optional) a character vector specifying packages to be attached in the R environment evaluating the future. |
local |
If TRUE, the expression is evaluated such that all assignments are done to local temporary environment, otherwise the assignments are done to the global environment of the R process evaluating the future. |
gc |
If TRUE, the garbage collector run (in the process that
evaluated the future) only after the value of the future is collected.
Exactly when the values are collected may depend on various factors such
as number of free workers and whether |
persistent |
If FALSE, the evaluation environment is cleared from objects prior to the evaluation of the future. |
workers |
A |
user |
(optional) The user name to be used when communicating with another host. |
master |
(optional) The hostname or IP address of the master machine running this node. |
revtunnel |
If TRUE, reverse SSH tunneling is used for the PSOCK cluster nodes to connect back to the master R process. This avoids the hassle of firewalls, port forwarding and having to know the internal / public IP address of the master R session. |
homogeneous |
If TRUE, all cluster nodes is assumed to use the same path to ‘Rscript’ as the main R session. If FALSE, the it is assumed to be on the PATH for each node. |
... |
Additional named elements passed to |
ClusterFuture()
returns an object of class ClusterFuture
.
MultisessionFuture()
returns an object of class
MultisessionFuture
, which inherits from ClusterFuture
.
To evaluate an expression using "cluster future", see function
cluster()
.