parallel: Parallel execution in the purrr::map style

mcmapR Documentation

Parallel execution in the purrr::map style

Description

mcmap() is a variant of parallel::mclapply() that accepts a formula as .f.

Usage

mcmap(.x, .f, ..., .mc.cores = getOption("mc.cores", 2L))

mcmap_lgl(.x, .f, ..., .mc.cores = getOption("mc.cores", 2L))

mcmap_int(.x, .f, ..., .mc.cores = getOption("mc.cores", 2L))

mcmap_dbl(.x, .f, ..., .mc.cores = getOption("mc.cores", 2L))

mcmap_chr(.x, .f, ..., .mc.cores = getOption("mc.cores", 2L))

Arguments

.x

A list or atomic vector.

.f

A function, specified in one of the following ways:

  • A named function, e.g. mean.

  • An anonymous function, e.g. ⁠\(x) x + 1⁠ or function(x) x + 1.

  • A formula, e.g. ~ .x + 1. You must use .x to refer to the first argument. Only recommended if you require backward compatibility with older versions of R.

  • A string, integer, or list, e.g. "idx", 1, or list("idx", 1) which are shorthand for ⁠\(x) pluck(x, "idx")⁠, ⁠\(x) pluck(x, 1)⁠, and ⁠\(x) pluck(x, "idx", 1)⁠ respectively. Optionally supply .default to set a default value if the indexed element is NULL or does not exist.

...

Additional arguments passed on to the mapped function.

We now generally recommend against using ... to pass additional (constant) arguments to .f. Instead use a shorthand anonymous function:

# Instead of
x |> map(f, 1, 2, collapse = ",")
# do:
x |> map(\(x) f(x, 1, 2, collapse = ","))

This makes it easier to understand which arguments belong to which function and will tend to yield better error messages.

.mc.cores

integer


heavywatal/rwtl documentation built on April 2, 2024, 6:08 p.m.