checkAtomic {checkmate} | R Documentation |
For the definition of “atomic”, see is.atomic
.
checkAtomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL, unique = FALSE, names = NULL) check_atomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL, unique = FALSE, names = NULL) assertAtomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL, unique = FALSE, names = NULL, .var.name = vname(x), add = NULL) assert_atomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL, unique = FALSE, names = NULL, .var.name = vname(x), add = NULL) testAtomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL, unique = FALSE, names = NULL) test_atomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL, unique = FALSE, names = NULL) expect_atomic(x, any.missing = TRUE, all.missing = TRUE, len = NULL, min.len = NULL, max.len = NULL, unique = FALSE, names = NULL, info = NULL, label = vname(x))
x |
[any] |
any.missing |
[ |
all.missing |
[ |
len |
[ |
min.len |
[ |
max.len |
[ |
unique |
[ |
names |
[ |
.var.name |
[ |
add |
[ |
info |
[character(1)] |
label |
[ |
Depending on the function prefix:
If the check is successful, the functions
assertAtmoic
/assert_atmoic
return
x
invisibly, whereas
checkAtmoic
/check_atmoic
and
testAtmoic
/test_atmoic
return
TRUE
.
If the check is not successful,
assertAtmoic
/assert_atmoic
throws an error message,
testAtmoic
/test_atmoic
returns FALSE
,
and checkAtmoic
returns a string with the error message.
The function expect_atmoic
always returns an
expectation
.
Other basetypes: checkArray
,
checkAtomicVector
,
checkCharacter
, checkComplex
,
checkDataFrame
, checkDate
,
checkEnvironment
,
checkFactor
, checkFunction
,
checkIntegerish
,
checkInteger
, checkList
,
checkLogical
, checkMatrix
,
checkNull
, checkNumeric
,
checkVector
Other atomicvector: checkAtomicVector
,
checkVector
testAtomic(letters, min.len = 1L, any.missing = FALSE)