ard_formals: Argument Values ARD

In cards: Analysis Results Data

Argument Values ARD

Description

Place default and passed argument values to a function into an ARD structure.

Usage

ard_formals(fun, arg_names, passed_args = list(), envir = parent.frame())

Arguments

fun	(function) a function passed to formals(fun)
arg_names	(character) character vector of argument names to return
passed_args	(named list) a named list of user-passed arguments. Default is list(), which returns all default values from a function
envir	(environment) an environment passed to formals(envir)

Value

an partial ARD data frame of class 'card'

Examples

# Example 1 ----------------------------------
# add the `mcnemar.test(correct)` argument to an ARD structure
ard_formals(fun = mcnemar.test, arg_names = "correct")

# Example 2 ----------------------------------
# S3 Methods need special handling to access the underlying method
ard_formals(
  fun = asNamespace("stats")[["t.test.default"]],
  arg_names = c("mu", "paired", "var.equal", "conf.level"),
  passed_args = list(conf.level = 0.90)
)

cards documentation built on Dec. 2, 2025, 9:07 a.m.