checkmate (version 1.7.3)

checkScalar: Check if an argument is a single atomic value

Description

Check if an argument is a single atomic value

Usage

checkScalar(x, na.ok = FALSE)
assertScalar(x, na.ok = FALSE, add = NULL, .var.name = NULL)
assert_scalar(x, na.ok = FALSE, add = NULL, .var.name = NULL)
testScalar(x, na.ok = FALSE)
test_scalar(x, na.ok = FALSE)
expect_scalar(x, na.ok = FALSE, info = NULL, label = NULL)

Arguments

x

[any] Object to check.

na.ok

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

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, assertScalar/assert_scalar throws an error message, testScalar/test_scalar returns FALSE, and checkScalar returns a string with the error message. The function expect_scalar always returns an expectation.

Details

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

See Also

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

Examples

testScalar(1)
testScalar(1:10)