File: parallelApply.R

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 (38 lines) | stat: -rw-r--r-- 1,438 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
#' Parallel versions of apply-family functions.
#'
#' `parallelLapply`: A parallel [lapply()] version.\cr
#' `parallelSapply`: A parallel [sapply()] version.\cr
#' All functions are simple wrappers for [parallelMap()].
#'
#' @param xs (`vector` | `list`)\cr
#'   `fun` is applied to the elements of this argument.
#' @param fun [`function`]\cr
#'   Function to map over `xs`.
#' @param ... (any)\cr
#'   Further arguments passed to `fun`.
#' @param simplify (`logical(1)`)\cr
#'   See [sapply()].
#'   Default is `TRUE`.
#' @param use.names (`logical(1)`)\cr
#'   See [sapply()].
#'   Default is `TRUE`.
#' @param impute.error (`NULL` | `function(x)`)\cr
#'   See [parallelMap()].
#' @param level (`character(1)`)\cr
#'   See [parallelMap()].
#' @return For `parallelLapply` a named list, for `parallelSapply` it depends
#'   on the return value of `fun` and the settings of `simplify` and
#'   `use.names`.
#' @export
parallelLapply = function(xs, fun, ..., impute.error = NULL, level = NA_character_) {
  parallelMap(fun, xs, more.args = list(...), simplify = FALSE, use.names = TRUE,
    impute.error = impute.error, level = level)
}

#' @rdname parallelLapply
#' @export
parallelSapply = function(xs, fun, ..., simplify = TRUE, use.names = TRUE, impute.error = NULL,
  level = NA_character_) {
  parallelMap(fun, xs, more.args = list(...), simplify = simplify, use.names = use.names,
    impute.error = impute.error, level = level)
}