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

BatchtoolsFuture {future.batchtools}

R Documentation

A batchtools future is a future whose value will be resolved via batchtools

Description

A batchtools future is a future whose value will be resolved via batchtools

Usage

BatchtoolsFuture(expr = NULL, envir = parent.frame(), substitute = TRUE,
  globals = TRUE, packages = NULL, label = NULL,
  cluster.functions = NULL, resources = list(), workers = NULL,
  finalize = getOption("future.finalize", TRUE), ...)

Arguments

`expr`	The R expression to be evaluated
`envir`	The environment in which global environment should be located.
`substitute`	Controls whether `expr` should be `substitute()`:d or not.
`globals`	(optional) a logical, a character vector, a named list, or a Globals object. If TRUE, globals are identified by code inspection based on `expr` and `tweak` searching from environment `envir`. If FALSE, no globals are used. If a character vector, then globals are identified by lookup based their names `globals` searching from environment `envir`. If a named list or a Globals object, the globals are used as is.
`label`	(optional) Label of the future (where applicable, becomes the job name for most job schedulers).
`cluster.functions`	A batchtools ClusterFunctions object.
`resources`	A named list passed to the batchtools template (available as variable `resources`).
`workers`	(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, whereas HPC backends where futures are resolved via separate jobs on a scheduler, the default is to assume an infinite number of workers.
`finalize`	If TRUE, any underlying registries are deleted when this object is garbage collected, otherwise not.
`conf`	A batchtools configuration environment.
`...`	Additional arguments passed to `future::Future()`.

Value

A BatchtoolsFuture object

[Package future.batchtools version 0.7.1 Index]