R: Check if an argument is named

checkNamed {checkmate}

R Documentation

Check if an argument is named

Description

Check if an argument is named

Usage

checkNamed(x, type = "named")

assertNamed(x, type = "named", .var.name)

testNamed(x, type = "named")

Arguments

`x`	[any] Object to check.
`type`	[character(1)] Select the check(s) to perform. “unnamed” checks `x` to be unnamed. “named” (default) checks `x` to be named which excludes names to be `NA` or emtpy (`""`). “unique” additionally tests for non-duplicated names. “strict” checks for unique names which comply to R's variable name restrictions. Note that for zero-length `x` every name check evalutes to `TRUE`. Also note that you can use `checkSubset` to check for a specific set of names.
`.var.name`	[character(1)] Name for `x`. Defaults to a heuristic to determine the name using `deparse` and `substitute`.

Value

Depending on the function prefix: If the check is successful, all functions return TRUE. If the check is not successful, assertNamed throws an error message, testNamed returns FALSE and checkNamed returns a string with the error message.

Examples

x = 1:3
testNamed(x, "unnamed")
names(x) = letters[1:3]
testNamed(x, "unique")

[Package checkmate version 1.6.0 Index]