validate_argument: Validate arguments against a given set of options

In easystats/insight: Easy Access to Model Information for Various Model Objects

Validate arguments against a given set of options

Description

This is a replacement for match.arg(), however, the error string should be more informative for users. The name of the affected argument is shown, and possible typos as well as remaining valid options. Not that the argument several.ok is always FALSE in validate_argument(), i.e. this function - unlike match.arg() - does not allow evaluating several valid options at once.

Usage

validate_argument(argument, options)

Arguments

argument	The bare name of the argument to be validated.
options	Valid options, usually a character vector.

Value

argument if it is a valid option, else an error is thrown.

Examples

foo <- function(test = "small") {
  validate_argument(test, c("small", "medium", "large"))
}
foo("small")
# errors:
# foo("masll")

easystats/insight documentation built on April 13, 2025, 8:38 a.m.