checkmate (version 1.0)

checkFlag: Check if an argument is a flag

Description

A flag a a single logical value.

Usage

checkFlag(x, na.ok = FALSE)
assertFlag(x, na.ok = FALSE, .var.name)
testFlag(x, na.ok = FALSE)

Arguments

x

[ANY] Object to check.

.var.name

[character(1)] Name for x. Defaults to a heuristic to determine the name using deparse and substitute.

na.ok

[logical(1)] Are missing values allowed? Default is FALSE.

Value

• Depending on the function prefix: If the check is successful, all functions return TRUE. If the check is not successful, assertFlag throws an error message, testFlag returns FALSE and checkFlag returns a string with the error message.

Details

This function does not distinguish between NA, NA_integer_, NA_real_, NA_complex_ NA_character_ and NaN.

See Also

Other scalars: assertCount, checkCount, testCount; assertInt, checkInt, testInt; assertNumber, checkNumber, testNumber; assertScalarNA, checkScalarNA, testScalarNA; assertScalar, checkScalar, testScalar; assertString, checkString, testString

Examples

testFlag(TRUE)
 testFlag(1)