bpoptions {BiocParallel} | R Documentation |
Additional options to parallel evaluation
Description
This function is used to pass additional options to bplapply()
and other functions function. One use case is to use the argument
BPOPTIONS
to temporarily change the parameter of BPPARAM
(e.g. enabling the progressbar). A second use case is to change the
behavior of the parallel evaluation (e.g. manually exporting some
variables to the worker)
Usage
bpoptions(
workers, tasks, jobname, log, logdir, threshold, resultdir,
stop.on.error, timeout, exportglobals, exportvariables, progressbar,
RNGseed, force.GC, fallback, exports, packages, ...
)
Arguments
workers |
integer(1) or character() parameter for |
tasks |
integer(1) parameter for |
jobname |
character(1) parameter for |
log |
logical(1) parameter for |
logdir |
character(1) parameter for |
threshold |
A parameter for |
resultdir |
character(1) parameter for |
stop.on.error |
logical(1) parameter for |
timeout |
integer(1) parameter for |
exportglobals |
logical(1) parameter for |
exportvariables |
A parameter for |
progressbar |
logical(1) parameter for |
RNGseed |
integer(1) parameter for |
force.GC |
logical(1) parameter for |
fallback |
logical(1) parameter for |
exports |
character() The names of the variables in the global
environment which need to be exported to the global environment of
the worker. This option works independently of the option
|
packages |
character() The packages that needs to be attached by
the worker prior to the evaluation of the task. This option works
independently of the option |
... |
Additional arguments which may(or may not) work for some specific
type of |
Value
A list of options
Author(s)
Jiefei Wang
See Also
BiocParallelParam
, bplapply
, bpiterate
.
Examples
p <- SerialParam()
bplapply(1:5, function(x) Sys.sleep(1), BPPARAM = p,
BPOPTIONS = bpoptions(progressbar = TRUE, tasks = 5L))