A conf BatchJobs future sources one or more BatchJobs configuration
files (R source scripts) to define the BatchJobs configuration
environment, e.g. .BatchJobs.R
.
batchjobs_custom(
expr,
envir = parent.frame(),
substitute = TRUE,
globals = TRUE,
label = "BatchJobs",
conf = NULL,
pathname = NULL,
workers = Inf,
resources = list(),
job.delay = FALSE,
...
)
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).
A BatchJobs configuration environment.
(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.
(optional) Additional specification for the backend workers. If NULL, the default is used.
A named list passed to the BatchJobs template (available as variable resources
).
(optional) Passed as is to submitJobs()
.
Additional arguments passed to BatchJobsFuture()
.
An object of class BatchJobsFuture
.
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)