1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
|
\name{bpschedule}
\alias{bpschedule}
\alias{bpschedule,missing-method}
\alias{bpschedule,ANY-method}
\title{Schedule back-end Params}
\description{
Use functions on this page to influence scheduling of parallel
processing.
}
\usage{
bpschedule(x)
}
\arguments{
\item{x}{
An instance of a \code{BiocParallelParam} class, e.g.,
\code{\link{MulticoreParam}}, \code{\link{SnowParam}},
\code{\link{DoparParam}}.
\code{x} can be missing, in which case the default back-end (see
\code{\link{register}}) is used.
}
}
\details{
\code{bpschedule} returns a logical(1) indicating whether the parallel
evaluation should occur at this point.
}
\value{
\code{bpschedule} returns a scalar logical.
}
\author{
Martin Morgan \url{mailto:mtmorgan@fhcrc.org}.
}
\seealso{
\code{\link{BiocParallelParam}} for possible values of \code{x}.
}
\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)
}
\keyword{manip}
|