BatchJobsFuture: A BatchJobs future is a future whose value will be resolved...

Description Usage Arguments Value

View source: R/BatchJobsFuture-class.R

Description

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

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
BatchJobsFuture(
  expr = NULL,
  envir = parent.frame(),
  substitute = TRUE,
  globals = TRUE,
  packages = NULL,
  label = "BatchJobs",
  conf = NULL,
  cluster.functions = NULL,
  resources = list(),
  workers = NULL,
  job.delay = FALSE,
  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).

conf

A BatchJobs configuration environment.

cluster.functions

A BatchJobs ClusterFunctions object.

resources

A named list passed to the BatchJobs template (available as variable resources).

workers

(optional) Additional specification for the BatchJobs backend.

job.delay

(optional) Passed as is to submitJobs().

finalize

If TRUE, any underlying registries are deleted when this object is garbage collected, otherwise not.

...

Additional arguments passed to Future().

Value

A BatchJobsFuture object


future.BatchJobs documentation built on Jan. 5, 2021, 1:07 a.m.