SerialParam-class

Enable serial evaluation

This class is used to parameterize serial evaluation, primarily to facilitate easy transition from parallel to serial code.

Keywords
classes
Usage
SerialParam(catch.errors = TRUE, log = FALSE, threshold = "INFO")
Arguments
catch.errors
logical(1) Enable the catching of errors and warnings.
log
logical(1) Enable logging.
threshold
character(1) Logging threshold as defined in futile.logger.

Constructor

SerialParam(catch.errors = TRUE, log = FALSE, threshold = "INFO"): Return an object to be used for serial evaluation of otherwise parallel functions such as bplapply, bpvec.

Methods

The following generics are implemented and perform as documented on the corresponding help page (e.g., ?bpworkers): bpworkers. bpisup, bpstart, bpstop, are implemented, but do not have any side-effects.

See Also

getClass("BiocParallelParam") for additional parameter classes.

register for registering parameter classes for use in parallel evaluation.

Aliases
  • SerialParam-class
  • SerialParam
  • bpisup,SerialParam-method
  • bpworkers,SerialParam-method
  • bplog,SerialParam-method
  • bpthreshold,SerialParam-method
  • bplog<-,SerialParam,logical-method
  • bpthreshold<-,SerialParam,character-method
Examples
p <- SerialParam()
simplify2array(bplapply(1:10, sqrt, BPPARAM=p))
bpvec(1:10, sqrt, BPPARAM=p)

## Not run: 
# register(SerialParam(), default=TRUE)
# ## End(Not run)
Documentation reproduced from package BiocParallel, version 1.2.22, License: GPL-2 | GPL-3

Community examples

Looks like there are no examples yet.