Last data update: 2014.03.03

R: Enable serial evaluation
SerialParam-classR Documentation

Enable serial evaluation

Description

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

Usage

SerialParam(catch.errors = TRUE, stop.on.error = TRUE, log = FALSE,
    threshold = "INFO", logdir= NA_character_)

Arguments

catch.errors

DEPRECATED; see SnowParam.

stop.on.error

A logical determining behavior on error; see SnowParam.

log

logical(1) Enable logging; see SnowParam.

threshold

character(1) Logging threshold; see SnowParam.

logdir

character(1) Log files directory. When not provided, log messages are returned to stdout.

Constructor

SerialParam(catch.errors = FALSE, 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.

Author(s)

Martin Morgan mailto:mtmorgan@fhcrc.org

See Also

getClass("BiocParallelParam") for additional parameter classes.

register for registering parameter classes for use in parallel evaluation.

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)

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(BiocParallel)
> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/BiocParallel/SerialParam-class.Rd_%03d_medium.png", width=480, height=480)
> ### Name: SerialParam-class
> ### Title: Enable serial evaluation
> ### Aliases: SerialParam-class SerialParam bpisup,SerialParam-method
> ###   bpworkers,SerialParam-method bplog,SerialParam-method
> ###   bplogdir,SerialParam-method bplog<-,SerialParam,logical-method
> ###   bpthreshold<-,SerialParam,character-method
> ###   bplogdir<-,SerialParam,character-method
> ### Keywords: classes
> 
> ### ** Examples
> 
> p <- SerialParam()
> simplify2array(bplapply(1:10, sqrt, BPPARAM=p))
 [1] 1.000000 1.414214 1.732051 2.000000 2.236068 2.449490 2.645751 2.828427
 [9] 3.000000 3.162278
> bpvec(1:10, sqrt, BPPARAM=p)
 [1] 1.000000 1.414214 1.732051 2.000000 2.236068 2.449490 2.645751 2.828427
 [9] 3.000000 3.162278
> 
> ## Not run: 
> ##D register(SerialParam(), default=TRUE)
> ## End(Not run)
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>