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

batchtools_template {future.batchtools}

R Documentation

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

Description

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

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, ...)

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).
`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`	A named list passed to the batchtools template (available as variable `resources`).
`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, 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()`.

Details

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

Value

An object of class BatchtoolsFuture.

[Package future.batchtools version 0.7.1 Index]