matchArg

This is an extensions to <code><a href="/link/match.arg?package=checkmate&version=2.3.2" data-mini-rdoc="checkmate::match.arg">match.arg</a></code> with support for <code>AssertCollection</code>.
The behavior is very similar to <code><a href="/link/match.arg?package=checkmate&version=2.3.2" data-mini-rdoc="checkmate::match.arg">match.arg</a></code>, except that <code>NULL</code> is not
a valid value for <code>x</code>.

Tests and assertions to perform frequent argument checks. A
substantial part of the package was written in C to minimize any worries
about execution time overhead.

Michel Lang

checkmate

Fast and Versatile Argument Checks

Bernd Bischl

Dénes Tóth

matchArg function

<dl><dt>x</dt>
<dd>[character] 
User provided argument to match.</dd>
<dt>choices</dt>
<dd>[character()] 
Candidates to match <code>x</code> with.</dd>
<dt>several.ok</dt>
<dd>[logical(1)] 
If <code>TRUE</code>, multiple matches are allowed, cf. <code><a href="/link/match.arg?package=checkmate&version=2.3.2" data-mini-rdoc="checkmate::match.arg">match.arg</a></code>.</dd>
<dt>.var.name</dt>
<dd>[<code>character(1)</code>] 
Name of the checked object to print in error messages. Defaults to
the heuristic implemented in <code>vname</code>.</dd>
<dt>add</dt>
<dd>[<code>AssertCollection</code>] 
Collection to store assertions. See <code>AssertCollection</code>.</dd></dl>

Arguments

This is an extensions to <code><a href='https://rdrr.io/r/base/match.arg.html'>match.arg</a></code> with support for <code>AssertCollection</code>.
The behavior is very similar to <code><a href='https://rdrr.io/r/base/match.arg.html'>match.arg</a></code>, except that <code>NULL</code> is not
a valid value for <code>x</code>.

Partial Argument Matching — matchArg

<dl>

<dt>x</dt>
<dd>[character] 
User provided argument to match.</dd>


<dt>choices</dt>
<dd>[character()] 
Candidates to match <code>x</code> with.</dd>


<dt>several.ok</dt>
<dd>[logical(1)] 
If <code>TRUE</code>, multiple matches are allowed, cf. <code><a href='https://rdrr.io/r/base/match.arg.html'>match.arg</a></code>.</dd>


<dt>.var.name</dt>
<dd>[<code>character(1)</code>] 
Name of the checked object to print in error messages. Defaults to
the heuristic implemented in <code>vname</code>.</dd>


<dt>add</dt>
<dd>[<code>AssertCollection</code>] 
Collection to store assertions. See <code>AssertCollection</code>.</dd>

</dl>

matchArg: Partial Argument Matching

Description

Usage

Value

Arguments

Examples