checkScalarNA {checkmate} | R Documentation |
Check if an argument is a single missing value
checkScalarNA(x, null.ok = FALSE) check_scalar_na(x, null.ok = FALSE) assertScalarNA(x, null.ok = FALSE, .var.name = vname(x), add = NULL) assert_scalar_na(x, null.ok = FALSE, .var.name = vname(x), add = NULL) testScalarNA(x, null.ok = FALSE) test_scalar_na(x, null.ok = FALSE) expect_scalar_na(x, null.ok = FALSE, info = NULL, label = vname(x))
x |
[any] |
null.ok |
[ |
.var.name |
[ |
add |
[ |
info |
[character(1)] |
label |
[ |
Depending on the function prefix:
If the check is successful, the functions
assertScalarNA
/assert_scalar_na
return
x
invisibly, whereas
checkScalarNA
/check_scalar_na
and
testScalarNA
/test_scalar_na
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
.
Other scalars: checkCount
,
checkFlag
, checkInt
,
checkNumber
, checkScalar
,
checkString
testScalarNA(1) testScalarNA(NA_real_) testScalarNA(rep(NA, 2))