Learn R Programming

checkmate (version 1.8.1)

matchArg: Partial Argument Matching

Description

This is an extensions to match.arg with support for AssertCollection. The behaviour is very similar to match.arg, except that NULL is not a valid value for x.

Usage

matchArg(x, choices, several.ok = FALSE, .var.name = vname(x), add = NULL)

Arguments

x
[character] User provided argument to match.
choices
[character()] Candidates to match x with.
several.ok
[logical(1)] If TRUE, multiple matches are allowed, cf. match.arg.
.var.name
[character(1)] Name of the checked object to print in error messages. Defaults to the heuristic implemented in vname.
add
[AssertCollection] Collection to store assertions. See AssertCollection.

Value

Subset of choices.

Examples

Run this code
matchArg("k", choices = c("kendall", "pearson"))

Run the code above in your browser using DataLab