fm_caller_args: Construct List of Arguments from Matched Caller Function

View source: R/future_mice.R

fm_caller_argsR Documentation

Construct List of Arguments from Matched Caller Function

Description

Construct List of Arguments from Matched Caller Function

Usage

fm_caller_args(
  n = 1,
  ...,
  defaults = FALSE,
  dots_env = NULL,
  dots_expand = TRUE
)

Arguments

n

The number of callers to go back.

...

These dots must be empty.

defaults

Whether to match missing arguments to their defaults.

dots_env

An execution environment where to find dots. If supplied and dots exist in this environment, and if call includes ..., the forwarded dots are matched to numbered dots (e.g. ..1, ..2, etc). By default this is set to the empty environment which means that ... expands to nothing.

dots_expand

If FALSE, arguments passed through ... will not be spliced into call. Instead, they are gathered in a pairlist and assigned to an argument named .... Gathering dots arguments is useful if you need to separate them from the other named arguments.

Note that the resulting call is not meant to be evaluated since R does not support passing dots through a named argument, even if named "...".

Value

A named list of arguments.


jesse-smith/futuremice documentation built on Nov. 24, 2023, 7:19 a.m.