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.
batchtools_lsf(expr, envir = parent.frame(), substitute = TRUE,
globals = TRUE, label = NULL, template = NULL, resources = list(),
workers = Inf, ...)batchtools_openlava(expr, envir = parent.frame(), substitute = TRUE,
globals = TRUE, label = NULL, template = NULL, resources = list(),
workers = Inf, ...)
batchtools_sge(expr, envir = parent.frame(), substitute = TRUE,
globals = TRUE, label = NULL, template = NULL, resources = list(),
workers = Inf, ...)
batchtools_slurm(expr, envir = parent.frame(), substitute = TRUE,
globals = TRUE, label = NULL, template = NULL, resources = list(),
workers = Inf, ...)
batchtools_torque(expr, envir = parent.frame(), substitute = TRUE,
globals = TRUE, label = NULL, template = NULL, resources = list(),
workers = Inf, ...)
The R expression to be evaluated
The environment in which global environment should be located.
Controls whether expr
should be
substitute()
:d or not.
(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.
(optional) Label of the future (where applicable, becomes the job name for most job schedulers).
(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.
A named list passed to the batchtools template (available
as variable resources
).
(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.
Additional arguments passed to BatchtoolsFuture()
.
An object of class BatchtoolsFuture
.
These type of batchtools futures rely on batchtools backends set up using the following batchtools functions: