batchtools_template | R Documentation |
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 = NULL, registry = list(), ... ) batchtools_openlava( expr, envir = parent.frame(), substitute = TRUE, globals = TRUE, label = NULL, template = NULL, resources = list(), workers = NULL, registry = list(), ... ) batchtools_sge( expr, envir = parent.frame(), substitute = TRUE, globals = TRUE, label = NULL, template = NULL, resources = list(), workers = NULL, registry = list(), ... ) batchtools_slurm( expr, envir = parent.frame(), substitute = TRUE, globals = TRUE, label = NULL, template = NULL, resources = list(), workers = NULL, registry = list(), ... ) batchtools_torque( expr, envir = parent.frame(), substitute = TRUE, globals = TRUE, label = NULL, template = NULL, resources = list(), workers = NULL, registry = list(), ... )
expr |
The R expression to be evaluated |
envir |
The environment in which global environment should be located. |
substitute |
Controls whether |
globals |
(optional) a logical, a character vector, a named list, or a
Globals object. If TRUE, globals are identified by code
inspection based on |
label |
(optional) Label of the future (where applicable, becomes the job name for most job schedulers). |
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. |
resources |
(optional) A named list passed to the batchtools
template (available as variable |
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 ( |
registry |
(optional) A named list of settings to control the setup of the batchtools registry. |
... |
Additional arguments passed to |
These type of batchtools futures rely on batchtools backends set up using the following batchtools functions:
batchtools::makeClusterFunctionsLSF()
for
Load Sharing Facility (LSF)
batchtools::makeClusterFunctionsOpenLava()
for
OpenLava
batchtools::makeClusterFunctionsSGE()
for
Sun/Oracle Grid Engine (SGE)
batchtools::makeClusterFunctionsSlurm()
for
Slurm
batchtools::makeClusterFunctionsTORQUE()
for
TORQUE / PBS
An object of class BatchtoolsFuture
.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.