R: A cluster future is a future whose value will be resolved...

ClusterFuture-class {future} | R Documentation

## A cluster future is a future whose value will be resolved asynchronously in a parallel process

### Description

A cluster future is a future whose value will be resolved asynchronously in a parallel process

### Usage

    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, ...)

### Arguments

`expr` | An R expression.
`envir` | The environment in which the evaluation is done (or inherits from if `local` is TRUE).
`substitute` | If TRUE, argument `expr` is `substitute()`:ed, otherwise not.
`globals` | (optional) a logical, a character vector, or a named list for controlling how globals are handled. For details, see section 'Globals used by future expressions' in the help for `future()`.
`persistent` | If FALSE, the evaluation environment is cleared from objects prior to the evaluation of the future.
`workers` | A `cluster`. Alternatively, a character vector of host names or a numeric scalar, for creating a cluster via `makeCluster(workers)`.
`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 `Future()`.
`sessioninfo` | If TRUE, session information is collected for each cluster node, otherwise not. This also servers as testing that each node is working properly.

### Value

An object of class `ClusterFuture`.

### See Also

To evaluate an expression using "cluster future", see function `cluster()`.

[Package future version 1.8.0 Index]