bpschedule

Schedule back-end Params

Use functions on this page to influence scheduling of parallel processing.

Keywords
manip
Usage
bpschedule(x, ...)
Arguments
x

An instance of a BiocParallelParam class, e.g., MulticoreParam, SnowParam, DoparParam.

x can be missing, in which case the default back-end (see register) is used.

...
Additional arguments, perhaps used by methods.
Details

bpschedule returns a logical(1) indicating whether the parallel evaluation should occur at this point.

Value

bpschedule returns a scalar logical.

See Also

BiocParallelParam for possible values of x.

Aliases
  • bpschedule
  • bpschedule,missing-method
  • bpschedule,ANY-method
Examples
bpschedule(SnowParam()) 		# TRUE
bpschedule(MulticoreParam(2))		# FALSE on windows

p <- MulticoreParam()
bpschedule(p)                           # TRUE
bplapply(1:2, function(i, p) {
    bpschedule(p)                       # FALSE
}, p = p, BPPARAM=p)
Documentation reproduced from package BiocParallel, version 1.2.22, License: GPL-2 | GPL-3

Community examples

Looks like there are no examples yet.