Future backends based on the 'batchtools' framework

Usage

BatchtoolsFutureBackend(
  workers = NULL,
  resources = list(),
  conf.file = findConfFile(),
  cluster.functions = NULL,
  registry = list(),
  finalize = isTRUE(getOption("future.finalize")),
  ...
)

BatchtoolsLocalFutureBackend(..., cluster.functions = NULL)

Arguments

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 (workers = 1L), whereas HPC backends, where futures are resolved via separate jobs on a scheduler, can have multiple workers. In the latter, the default is workers = NULL, which will resolve to getOption("future.batchtools.workers"). If neither are specified, then the default is 100.
resources: (optional) A named list passed to the batchtools template (available as variable resources). See Section 'Resources' in batchtools::submitJobs() more details.
conf.file: (optional) A batchtools configuration file.
cluster.functions: (optional) A batchtools ClusterFunctions object.
registry: (optional) A named list of settings to control the setup of the batchtools registry.
finalize: If TRUE, any underlying registries are deleted when this object is garbage collected, otherwise not.
...: Additional arguments passed to FutureBackend().

Value

An object of class BatchtoolsFutureBackend.