Skip to contents

Argument Verification Using Partial Matching

Source: R/match_arg.R
match_arg.Rd

Similar to match.arg(), match_arg matches arg against a table of candidate values as specified by choices.

Usage

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

Arguments

arg

a character vector (of length one unless several.ok is TRUE) or NULL which means to take choices[1].

choices

a character vector of candidate values, often missing, see ‘Details’.

several.ok

logical specifying if arg should be allowed to have more than one element.

Value

The matched elements of arg or in case of match failure a detailed error message

Details

This function resolves errors from match.arg() with '' as arg input.

Specification

The contents of this section are shown in PDF user manual only.

Examples

if (FALSE) {
match_arg(arg = c(2, 1), choices = c(4, 3, 1, 2), several.ok = TRUE)
match_arg(arg = c("c", "b"), choices = c("a", "b", "c", "d"), several.ok = TRUE)
}