checkCount {checkmate} | R Documentation |
A count is defined as non-negative integerish value.
checkCount(x, na.ok = FALSE, positive = FALSE, tol = sqrt(.Machine$double.eps), null.ok = FALSE) check_count(x, na.ok = FALSE, positive = FALSE, tol = sqrt(.Machine$double.eps), null.ok = FALSE) assertCount(x, na.ok = FALSE, positive = FALSE, tol = sqrt(.Machine$double.eps), null.ok = FALSE, .var.name = vname(x), add = NULL) assert_count(x, na.ok = FALSE, positive = FALSE, tol = sqrt(.Machine$double.eps), null.ok = FALSE, .var.name = vname(x), add = NULL) testCount(x, na.ok = FALSE, positive = FALSE, tol = sqrt(.Machine$double.eps), null.ok = FALSE) test_count(x, na.ok = FALSE, positive = FALSE, tol = sqrt(.Machine$double.eps), null.ok = FALSE) expect_count(x, na.ok = FALSE, positive = FALSE, tol = sqrt(.Machine$double.eps), null.ok = FALSE, info = NULL, label = vname(x))
x |
[any] |
na.ok |
[ |
positive |
[ |
tol |
[ |
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
assertCount
/assert_count
return
x
invisibly, whereas
checkCount
/check_count
and
testCount
/test_count
return
TRUE
.
If the check is not successful,
assertCount
/assert_count
throws an error message,
testCount
/test_count
returns FALSE
,
and checkCount
returns a string with the error message.
The function expect_count
always returns an
expectation
.
Other scalars: checkFlag
,
checkInt
, checkNumber
,
checkScalarNA
, checkScalar
,
checkString
testCount(1) testCount(-1)