Check if an argument is a flag
A flag is defined as single logical value.
checkFlag(x, na.ok = FALSE, null.ok = FALSE) check_flag(x, na.ok = FALSE, null.ok = FALSE) assertFlag(x, na.ok = FALSE, null.ok = FALSE, .var.name = vname(x), add = NULL) assert_flag( x, na.ok = FALSE, null.ok = FALSE, .var.name = vname(x), add = NULL ) testFlag(x, na.ok = FALSE, null.ok = FALSE) test_flag(x, na.ok = FALSE, null.ok = FALSE) expect_flag(x, na.ok = FALSE, null.ok = FALSE, info = NULL, label = vname(x))
x |
[any] |
na.ok |
[ |
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
assertFlag
/assert_flag
return
x
invisibly, whereas
checkFlag
/check_flag
and
testFlag
/test_flag
return
TRUE
.
If the check is not successful,
assertFlag
/assert_flag
throws an error message,
testFlag
/test_flag
returns FALSE
,
and checkFlag
returns a string with the error message.
The function expect_flag
always returns an
expectation
.
Other scalars:
checkCount()
,
checkInt()
,
checkNumber()
,
checkScalarNA()
,
checkScalar()
,
checkString()
testFlag(TRUE) testFlag(1)
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.