batchjobs_template: BatchJobs LSF, OpenLava, SGE, Slurm and Torque futures

In HenrikBengtsson/future.BatchJobs: A Future API for Parallel and Distributed Processing using BatchJobs

Description

LSF, OpenLava, SGE, Slurm and Torque BatchJobs futures are asynchronous multiprocess futures that will be evaluated on a compute cluster via a job scheduler.

Usage

batchjobs_lsf(
  expr,
  envir = parent.frame(),
  substitute = TRUE,
  globals = TRUE,
  label = "BatchJobs",
  pathname = NULL,
  resources = list(),
  workers = Inf,
  job.delay = FALSE,
  ...
)

batchjobs_openlava(
  expr,
  envir = parent.frame(),
  substitute = TRUE,
  globals = TRUE,
  label = "BatchJobs",
  pathname = NULL,
  resources = list(),
  workers = Inf,
  job.delay = FALSE,
  ...
)

batchjobs_sge(
  expr,
  envir = parent.frame(),
  substitute = TRUE,
  globals = TRUE,
  label = "BatchJobs",
  pathname = NULL,
  resources = list(),
  workers = Inf,
  job.delay = FALSE,
  ...
)

batchjobs_slurm(
  expr,
  envir = parent.frame(),
  substitute = TRUE,
  globals = TRUE,
  label = "BatchJobs",
  pathname = NULL,
  resources = list(),
  workers = Inf,
  job.delay = FALSE,
  ...
)

batchjobs_torque(
  expr,
  envir = parent.frame(),
  substitute = TRUE,
  globals = TRUE,
  label = "BatchJobs",
  pathname = NULL,
  resources = list(),
  workers = Inf,
  job.delay = FALSE,
  ...
)

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).
pathname	A BatchJobs template file (brew formatted).
resources	A named list passed to the BatchJobs template (available as variable resources).
workers	(optional) Additional specification for the BatchJobs backend.
job.delay	(optional) Passed as is to submitJobs().
...	Additional arguments passed to BatchJobsFuture().

Details

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

• makeClusterFunctionsLSF() for Load Sharing Facility (LSF)

• makeClusterFunctionsOpenLava() for OpenLava

• makeClusterFunctionsSGE() for Sun/Oracle Grid Engine (SGE)

• makeClusterFunctionsSLURM() for Slurm

• makeClusterFunctionsTorque() for TORQUE / PBS

Value

An object of class BatchJobsFuture.

HenrikBengtsson/future.BatchJobs documentation built on Feb. 15, 2021, 3:17 a.m.