invoke: Invoke a Function Call

In mlr-org/mlr3misc: Helper Functions for 'mlr3'

Invoke a Function Call

Description

An alternative interface for do.call(), similar to the deprecated function in purrr. This function tries hard to not evaluate the passed arguments too eagerly which is important when working with large R objects.

It is recommended to pass all arguments named in order to not rely on positional argument matching.

Usage

invoke(
  .f,
  ...,
  .args = list(),
  .opts = list(),
  .seed = NA_integer_,
  .timeout = Inf
)

Arguments

.f	(⁠function()⁠) Function to call.
...	(any) Additional function arguments passed to .f.
.args	(list()) Additional function arguments passed to .f, as (named) list(). These arguments will be concatenated to the arguments provided via ....
.opts	(named list()) List of options which are set before the .f is called. Options are reset to their previous state afterwards.
.seed	(integer(1)) Random seed to set before invoking the function call. Gets reset to the previous seed on exit.
.timeout	(numeric(1)) Timeout in seconds. Uses setTimeLimit(). Note that timeouts are only triggered on a user interrupt, not in compiled code.

Examples

invoke(mean, .args = list(x = 1:10))
invoke(mean, na.rm = TRUE, .args = list(1:10))

mlr-org/mlr3misc documentation built on April 13, 2024, 3:37 p.m.