match_arg: Argument Verification Using Partial Matching

Description Usage Arguments Details Value Specification Examples

View source: R/match_arg.R

Description

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

Usage

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

Arguments

arg

a character vector (of length one unless several.ok is TRUE) or NULL.

choices

a character vector of candidate values

several.ok

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

Details

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

Value

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

Specification

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

Examples

1
2
3
4
5
## Not run: 
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)

## End(Not run)

r2rtf documentation built on Sept. 10, 2021, 1:06 a.m.