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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
|
\name{clusterApply}
\alias{clusterCall}
\alias{clusterApply}
\alias{clusterApplyLB}
\alias{clusterEvalQ}
\alias{clusterExport}
\alias{clusterMap}
\alias{clusterSplit}
\alias{parLapply}
\alias{parSapply}
\alias{parApply}
\alias{parRapply}
\alias{parCapply}
\alias{parLapplyLB}
\alias{parSapplyLB}
\title{Apply operations using clusters}
\description{
These functions provide several ways to parallelize computations
using a cluster.
NOTE: This man page is for the \code{clusterCall}, \code{clusterApply},
\code{clusterApplyLB}, \code{clusterEvalQ}, \code{clusterExport},
\code{clusterMap}, \code{clusterSplit}, \code{parLapply}, \code{parSapply},
\code{parApply}, \code{parRapply}, \code{parCapply}, \code{parLapplyLB},
and \code{parSapplyLB} \emph{S4 generic functions} defined in the
\pkg{BiocGenerics} package.
See \code{?parallel::\link[parallel]{clusterApply}} for the default
methods (defined in the \pkg{parallel} package).
Bioconductor packages can define specific methods for cluster-like
objects not supported by the default methods.
}
\usage{
clusterCall(cl=NULL, fun, ...)
clusterApply(cl=NULL, x, fun, ...)
clusterApplyLB(cl=NULL, x, fun, ...)
clusterEvalQ(cl=NULL, expr)
clusterExport(cl=NULL, varlist, envir=.GlobalEnv)
clusterMap(cl=NULL, fun, ..., MoreArgs=NULL, RECYCLE=TRUE,
SIMPLIFY=FALSE, USE.NAMES=TRUE,
.scheduling=c("static", "dynamic"))
clusterSplit(cl=NULL, seq)
parLapply(cl=NULL, X, fun, ..., chunk.size=NULL)
parSapply(cl=NULL, X, FUN, ..., simplify=TRUE,
USE.NAMES=TRUE, chunk.size=NULL)
parApply(cl=NULL, X, MARGIN, FUN, ..., chunk.size=NULL)
parRapply(cl=NULL, x, FUN, ..., chunk.size=NULL)
parCapply(cl=NULL, x, FUN, ..., chunk.size=NULL)
parLapplyLB(cl=NULL, X, fun, ..., chunk.size=NULL)
parSapplyLB(cl=NULL, X, FUN, ..., simplify=TRUE,
USE.NAMES=TRUE, chunk.size=NULL)
}
\arguments{
\item{cl}{
A cluster-like object.
}
\item{x}{
A vector-like object for \code{clusterApply} and \code{clusterApplyLB}.
A matrix-like object for \code{parRapply} and \code{parCapply}.
}
\item{seq}{
Vector-like object to split.
}
\item{X}{
A vector-like object for \code{parLapply}, \code{parSapply},
\code{parLapplyLB}, and \code{parSapplyLB}.
An array-like object for \code{parApply}.
}
\item{fun, ..., expr, varlist, envir, MoreArgs, RECYCLE, SIMPLIFY,
USE.NAMES, .scheduling, chunk.size, FUN, simplify, MARGIN}{
See \code{?parallel::\link[parallel]{clusterApply}} for a description of
these arguments.
}
}
\value{
See \code{?parallel::\link[parallel]{clusterApply}} for the value returned
by the default methods.
Specific methods defined in Bioconductor packages should behave like the
default methods.
}
\seealso{
\itemize{
\item \code{parallel::\link[parallel]{clusterApply}} for the default
methods.
\item \code{\link[methods]{showMethods}} for displaying a summary of the
methods defined for a given generic function.
\item \code{\link[methods]{selectMethod}} for getting the definition of
a specific method.
\item \link{BiocGenerics} for a summary of all the generics defined
in the \pkg{BiocGenerics} package.
}
}
\examples{
clusterCall # note the dispatch on the 'cl' arg only
showMethods("clusterCall")
selectMethod("clusterCall", "ANY") # the default method
clusterApply # note the dispatch on the 'cl' and 'x' args only
showMethods("clusterApply")
selectMethod("clusterApply", c("ANY", "ANY")) # the default method
clusterApplyLB # note the dispatch on the 'cl' and 'x' args only
showMethods("clusterApplyLB")
selectMethod("clusterApplyLB", c("ANY", "ANY")) # the default method
clusterEvalQ # note the dispatch on the 'cl' arg only
showMethods("clusterEvalQ")
selectMethod("clusterEvalQ", "ANY") # the default method
clusterExport # note the dispatch on the 'cl' arg only
showMethods("clusterExport")
selectMethod("clusterExport", "ANY") # the default method
clusterMap # note the dispatch on the 'cl' arg only
showMethods("clusterMap")
selectMethod("clusterMap", "ANY") # the default method
clusterSplit
showMethods("clusterSplit")
selectMethod("clusterSplit", c("ANY", "ANY")) # the default method
parLapply # note the dispatch on the 'cl' and 'X' args only
showMethods("parLapply")
selectMethod("parLapply", c("ANY", "ANY")) # the default method
parSapply # note the dispatch on the 'cl' and 'X' args only
showMethods("parSapply")
selectMethod("parSapply", c("ANY", "ANY")) # the default method
parApply # note the dispatch on the 'cl' and 'X' args only
showMethods("parApply")
selectMethod("parApply", c("ANY", "ANY")) # the default method
parRapply # note the dispatch on the 'cl' and 'x' args only
showMethods("parRapply")
selectMethod("parRapply", c("ANY", "ANY")) # the default method
parCapply # note the dispatch on the 'cl' and 'x' args only
showMethods("parCapply")
selectMethod("parCapply", c("ANY", "ANY")) # the default method
parLapplyLB # note the dispatch on the 'cl' and 'X' args only
showMethods("parLapplyLB")
selectMethod("parLapplyLB", c("ANY", "ANY")) # the default method
parSapplyLB # note the dispatch on the 'cl' and 'X' args only
showMethods("parSapplyLB")
selectMethod("parSapplyLB", c("ANY", "ANY")) # the default method
}
\keyword{methods}
|