checkmate (version 1.7.3)

checkScalarNA: Check if an argument is a single missing value

Description

Check if an argument is a single missing value

Usage

checkScalarNA(x)
assertScalarNA(x, add = NULL, .var.name = NULL)
assert_scalar_na(x, add = NULL, .var.name = NULL)
testScalarNA(x)
test_scalar_na(x)
expect_scalar_na(x, info = NULL, label = NULL)

Arguments

x

[any] Object to check.

add

[AssertCollection] Collection to store assertions. See AssertCollection.

.var.name

[NULL || character(1)] Name of the checked object to print in error message. If NULL, the name will be heuristically determined via substitute.

info

[character(1)] Extra information to be included in the message for the testthat reporter. See expect_that.

label

[character(1)] Same as .var.name, but passed down to expect_that.

Value

• Depending on the function prefix: If the check is successful, the functions return TRUE. If the check is not successful, assertScalarNA/assert_scalar_na throws an error message, testScalarNA/test_scalar_na returns FALSE, and checkScalarNA returns a string with the error message. The function expect_scalar_na always returns an expectation.

See Also

Other scalars: checkCount, checkFlag, checkInt, checkNumber, checkScalar, checkString

Examples

testScalarNA(1)
testScalarNA(NA_real_)
testScalarNA(rep(NA, 2))