args_default {cSEM}R Documentation

Show argument defaults or candidates

Description

Show all arguments used by package functions including default or candidate values. For argument descriptions see: csem_arguments.

Usage

args_default(.choices = FALSE)

Arguments

.choices

Logical. Should candidate values for the arguments be returned? Defaults to FALSE.

Details

By default args_default()returns a list of default values by argument name. If the list of accepted candidate values is required instead, use .choices = TRUE.

Value

A named list of argument names and defaults or accepted candidates.

See Also

handleArgs(), csem_arguments, csem(), foreman()


[Package cSEM version 0.4.0 Index]