checkInt {checkmate} | R Documentation |
Check if an argument is a single integerish value
checkInt(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE
)
check_int(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE
)
assertInt(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE,
coerce = FALSE,
.var.name = vname(x),
add = NULL
)
assert_int(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE,
coerce = FALSE,
.var.name = vname(x),
add = NULL
)
testInt(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE
)
test_int(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE
)
expect_int(
x,
na.ok = FALSE,
lower = -Inf,
upper = Inf,
tol = sqrt(.Machine$double.eps),
null.ok = FALSE,
info = NULL,
label = vname(x)
)
x |
[any] |
na.ok |
[ |
lower |
[ |
upper |
[ |
tol |
[ |
null.ok |
[ |
coerce |
[ |
.var.name |
[ |
add |
[ |
info |
[ |
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
assertInt
/assert_int
return
x
invisibly, whereas
checkInt
/check_int
and
testInt
/test_int
return
TRUE
.
If the check is not successful,
assertInt
/assert_int
throws an error message,
testInt
/test_int
returns FALSE
,
and checkInt
/check_int
return a string with the error message.
The function expect_int
always returns an
expectation
.
To perform an assertion and then convert to integer, use asInt
.
assertInt
will not convert numerics to integer.
Other scalars:
checkCount()
,
checkFlag()
,
checkNumber()
,
checkScalarNA()
,
checkScalar()
,
checkString()
testInt(1)
testInt(-1, lower = 0)