Skip to contents

Argument matching

Source: R/match_arg.R
match_arg.Rd

This function matches function arguments and is a modified version of match.arg.

Usage

match_arg(arg, choices, several.ok = FALSE, none.ok = FALSE)

Arguments

arg

[character()]
The function argument.

choices

[character()]
Allowed values for arg.

several.ok

[logical(1)]
Is arg allowed to have more than one element?

none.ok

[logical(1)]
Is arg allowed to have zero elements?

Value

The un-abbreviated version of the exact or unique partial match if there is one. Otherwise, an error is signaled if several.ok is FALSE or none.ok is FALSE. When several.ok is TRUE and (at least) one element of arg has a match, all un-abbreviated versions of matches are returned. When none.ok is TRUE and arg has zero elements, character(0) is returned.

See also

Other package helpers: Dictionary, Storage, identical_structure(), input_check_response(), package_logo(), print_data.frame(), print_matrix(), system_information(), unexpected_error(), user_confirm()