checkNumber {checkmate} | R Documentation |
Check if an argument is a single numeric value
checkNumber(x, na.ok = FALSE, lower = -Inf, upper = Inf, finite = FALSE, null.ok = FALSE) check_number(x, na.ok = FALSE, lower = -Inf, upper = Inf, finite = FALSE, null.ok = FALSE) assertNumber(x, na.ok = FALSE, lower = -Inf, upper = Inf, finite = FALSE, null.ok = FALSE, .var.name = vname(x), add = NULL) assert_number(x, na.ok = FALSE, lower = -Inf, upper = Inf, finite = FALSE, null.ok = FALSE, .var.name = vname(x), add = NULL) testNumber(x, na.ok = FALSE, lower = -Inf, upper = Inf, finite = FALSE, null.ok = FALSE) test_number(x, na.ok = FALSE, lower = -Inf, upper = Inf, finite = FALSE, null.ok = FALSE) expect_number(x, na.ok = FALSE, lower = -Inf, upper = Inf, finite = FALSE, null.ok = FALSE, info = NULL, label = vname(x))
x |
[any] |
na.ok |
[ |
lower |
[ |
upper |
[ |
finite |
[ |
null.ok |
[ |
.var.name |
[ |
add |
[ |
info |
[character(1)] |
label |
[ |
This function does not distinguish between
NA
, NA_integer_
, NA_real_
, NA_complex_
NA_character_
and NaN
.
Depending on the function prefix:
If the check is successful, the functions
assertNumber
/assert_number
return
x
invisibly, whereas
checkNumber
/check_number
and
testNumber
/test_number
return
TRUE
.
If the check is not successful,
assertNumber
/assert_number
throws an error message,
testNumber
/test_number
returns FALSE
,
and checkNumber
returns a string with the error message.
The function expect_number
always returns an
expectation
.
Other scalars: checkCount
,
checkFlag
, checkInt
,
checkScalarNA
, checkScalar
,
checkString
testNumber(1) testNumber(1:2)