pmap_struct: Map over multiple input simultaneously (in "parallel")

In terminological/ggrrr: Addressing Annoyances and Irritations

Map over multiple input simultaneously (in "parallel")

Description

These functions are variants of map() that iterate over multiple arguments simultaneously. They are parallel in the sense that each input is processed in parallel with the others, not in the sense of multicore computing, i.e. they share the same notion of "parallel" as base::pmax() and base::pmin().

Usage

pmap_struct(.l, .f, ..., .progress = FALSE)

Arguments

.l	A list of vectors. The length of .l determines the number of arguments that .f will be called with. Arguments will be supply by position if unnamed, and by name if named. Vectors of length 1 will be recycled to any length; all other elements must be have the same length. A data frame is an important special case of .l. It will cause .f to be called once for each row.
.f	A function, specified in one of the following ways: A named function. An anonymous function, e.g. ⁠\(x, y, z) x + y / z⁠ or function(x, y, z) x + y / z A formula, e.g. ~ ..1 + ..2 / ..3. This syntax is not recommended as you can only refer to arguments by position.
...	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.
.progress	Whether to show a progress bar. Use TRUE to turn on a basic progress bar, use a string to give it a name, or see progress_bars for more details.

Value

a 'struct_list'

terminological/ggrrr documentation built on June 15, 2024, 6:35 a.m.