| future_map | R Documentation |
These functions work the same as purrr::map() and its variants, but
allow you to map in parallel.
future_map(
.x,
.f,
...,
.options = furrr_options(),
.env_globals = parent.frame(),
.progress = FALSE
)
future_map_chr(
.x,
.f,
...,
.options = furrr_options(),
.env_globals = parent.frame(),
.progress = FALSE
)
future_map_dbl(
.x,
.f,
...,
.options = furrr_options(),
.env_globals = parent.frame(),
.progress = FALSE
)
future_map_int(
.x,
.f,
...,
.options = furrr_options(),
.env_globals = parent.frame(),
.progress = FALSE
)
future_map_lgl(
.x,
.f,
...,
.options = furrr_options(),
.env_globals = parent.frame(),
.progress = FALSE
)
future_map_vec(
.x,
.f,
...,
.ptype = NULL,
.options = furrr_options(),
.env_globals = parent.frame(),
.progress = FALSE
)
future_map_dfr(
.x,
.f,
...,
.id = NULL,
.options = furrr_options(),
.env_globals = parent.frame(),
.progress = FALSE
)
future_map_dfc(
.x,
.f,
...,
.options = furrr_options(),
.env_globals = parent.frame(),
.progress = FALSE
)
future_walk(
.x,
.f,
...,
.options = furrr_options(),
.env_globals = parent.frame(),
.progress = FALSE
)
.x |
A list or atomic vector. |
.f |
A function, specified in one of the following ways:
|
... |
Additional arguments passed on to the mapped function. We now generally recommend against using # Instead of x |> future_map(f, 1, 2, collapse = ",") # do: x |> future_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. |
.options |
The |
.env_globals |
The environment to look for globals required by |
.progress |
A single logical. Should a progress bar be displayed? Only works with multisession, multicore, and multiprocess futures. Note that if a multicore/multisession future falls back to sequential, then a progress bar will not be displayed. Warning: The |
.ptype |
If |
.id |
Either a string or Only applies to |
All functions return a vector the same length as .x.
future_map() returns a list
future_map_lgl() a logical vector
future_map_int() an integer vector
future_map_dbl() a double vector
future_map_chr() a character vector
The output of .f will be automatically typed upwards, e.g. logical ->
integer -> double -> character.
plan(multisession, workers = 2)
1:10 |>
future_map(rnorm, n = 10, .options = furrr_options(seed = 123)) |>
future_map_dbl(mean)
# If each element of the output is a data frame, use
# `future_map_dfr()` to row-bind them together:
mtcars |>
split(mtcars$cyl) |>
future_map(~ lm(mpg ~ wt, data = .x)) |>
future_map_dfr(~ as.data.frame(t(as.matrix(coef(.)))))
# You can be explicit about what gets exported to the workers.
# To see this, use multisession (not multicore as the forked workers
# still have access to this environment)
plan(multisession)
x <- 1
y <- 2
# This will fail, y is not exported (no black magic occurs)
try(future_map(1, ~y, .options = furrr_options(globals = "x")))
# y is exported
future_map(1, ~y, .options = furrr_options(globals = "y"))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.