File: parallelLapply.Rd

package info (click to toggle)
r-cran-parallelmap 1.5.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 336 kB
  • sloc: sh: 13; makefile: 2
file content (53 lines) | stat: -rw-r--r-- 1,501 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/parallelApply.R
\name{parallelLapply}
\alias{parallelLapply}
\alias{parallelSapply}
\title{Parallel versions of apply-family functions.}
\usage{
parallelLapply(xs, fun, ..., impute.error = NULL, level = NA_character_)

parallelSapply(
  xs,
  fun,
  ...,
  simplify = TRUE,
  use.names = TRUE,
  impute.error = NULL,
  level = NA_character_
)
}
\arguments{
\item{xs}{(\code{vector} | \code{list})\cr
\code{fun} is applied to the elements of this argument.}

\item{fun}{\code{\link{function}}\cr
Function to map over \code{xs}.}

\item{...}{(any)\cr
Further arguments passed to \code{fun}.}

\item{impute.error}{(\code{NULL} | \verb{function(x)})\cr
See \code{\link[=parallelMap]{parallelMap()}}.}

\item{level}{(\code{character(1)})\cr
See \code{\link[=parallelMap]{parallelMap()}}.}

\item{simplify}{(\code{logical(1)})\cr
See \code{\link[=sapply]{sapply()}}.
Default is \code{TRUE}.}

\item{use.names}{(\code{logical(1)})\cr
See \code{\link[=sapply]{sapply()}}.
Default is \code{TRUE}.}
}
\value{
For \code{parallelLapply} a named list, for \code{parallelSapply} it depends
on the return value of \code{fun} and the settings of \code{simplify} and
\code{use.names}.
}
\description{
\code{parallelLapply}: A parallel \code{\link[=lapply]{lapply()}} version.\cr
\code{parallelSapply}: A parallel \code{\link[=sapply]{sapply()}} version.\cr
All functions are simple wrappers for \code{\link[=parallelMap]{parallelMap()}}.
}