filter_call_args: Filter and merge arguments for function calls

View source: R/summary_utility_functions.R

filter_call_argsR Documentation

Filter and merge arguments for function calls

Description

Simplifies the common pattern of filtering arguments from a source list to match a target function's formal parameters, then adding/overriding specific arguments.

Usage

filter_call_args(source_args, target_func, override_args = NULL)

Arguments

source_args

List of all arguments (typically from mget() or a stored args list).

target_func

Function whose formals define the filter criteria.

override_args

List of arguments to add or override (optional).

Details

This function:

  1. Extracts formal parameter names from target_func

  2. Keeps only arguments from source_args that match those names

  3. Adds or overrides with any override_args provided

Reduces boilerplate and improves readability across the codebase.

Value

List of filtered arguments ready for do.call().

Examples

## Not run: 
# Instead of:
args_FS <- names(formals(get_FSdata))
args_FS_filtered <- args_call_all[names(args_call_all) %in% args_FS]
args_FS_filtered$df.analysis <- df.analysis
args_FS_filtered$grf_cuts <- grf_cuts
FSdata <- do.call(get_FSdata, args_FS_filtered)

# You now write:
FSdata <- do.call(get_FSdata,
  filter_call_args(args_call_all, get_FSdata,
                   list(df.analysis = df.analysis, grf_cuts = grf_cuts)))

## End(Not run)


forestsearch documentation built on Nov. 15, 2026, 9:06 a.m.