Skip to contents

Batchtools futures for LSF, OpenLava, SGE, Slurm, TORQUE etc.

Source: R/BatchtoolsTemplateFutureBackend-class.R
BatchtoolsTemplateFutureBackend.Rd

Batchtools futures for LSF, OpenLava, SGE, Slurm, TORQUE etc. are asynchronous multiprocess futures that will be evaluated on a compute cluster via a job scheduler.

Usage

BatchtoolsTemplateFutureBackend(
  type = c("lsf", "openlava", "sge", "slurm", "torque"),
  scheduler.latency = 1,
  fs.latency = 65,
  template = NULL,
  ...
)

Arguments

type

(character string) Type of job scheduler.

scheduler.latency

[numeric(1)]
Time to sleep after important interactions with the scheduler to ensure a sane state. Currently only triggered after calling submitJobs.

fs.latency

[numeric(1)]
Expected maximum latency of the file system, in seconds. Set to a positive number for network file systems like NFS which enables more robust (but also more expensive) mechanisms to access files and directories. Usually safe to set to 0 to disable the heuristic, e.g. if you are working on a local file system.

template

(optional) A batchtools template file or a template string (in brew format). If not specified, it is left to the batchtools package to locate such file using its search rules.

...

Additional arguments passed to BatchtoolsFutureBackend().

Value

An object of class BatchtoolsFutureBackend.

Details

These type of batchtools futures rely on batchtools backends set up using the following batchtools functions: