batchjobs_custom: BatchJobs conf futures

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

Description

A conf BatchJobs future sources one or more BatchJobs configuration files (R source scripts) to define the BatchJobs configuration environment, e.g. ‘.BatchJobs.R’.

Usage

batchjobs_custom(
  expr,
  envir = parent.frame(),
  substitute = TRUE,
  globals = TRUE,
  label = "BatchJobs",
  conf = NULL,
  pathname = NULL,
  workers = Inf,
  resources = list(),
  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).
conf	A BatchJobs configuration environment.
pathname	(alternative) Pathname to one or more BatchJobs configuration files to be loaded in order. If NULL, then the BatchJobs package will search for such configuration files.
workers	(optional) Additional specification for the backend workers. If NULL, the default is used.
resources	A named list passed to the BatchJobs template (available as variable resources).
job.delay	(optional) Passed as is to submitJobs().
...	Additional arguments passed to BatchJobsFuture().

Details

If conf is NULL (default), then the BatchJobs configuration will be created from a set of BatchJobs configuration files (R script files) as given by argument pathname. If none are specified (default), then BatchJobs is designed to use (in order) all of following configuration files (if they exist):

• system("etc", "BatchJobs_global_config.R", package="BatchJobs")

• ~/.BatchJobs.R (in user's home directory)

• .BatchJobs.R (in the current directory)

Value

An object of class BatchJobsFuture.

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