checkEnvironment {checkmate} | R Documentation |
Check if an argument is an environment
checkEnvironment(x, contains = character(0L), null.ok = FALSE) check_environment(x, contains = character(0L), null.ok = FALSE) assertEnvironment(x, contains = character(0L), null.ok = FALSE, .var.name = vname(x), add = NULL) assert_environment(x, contains = character(0L), null.ok = FALSE, .var.name = vname(x), add = NULL) testEnvironment(x, contains = character(0L), null.ok = FALSE) test_environment(x, contains = character(0L), null.ok = FALSE) expect_environment(x, contains = character(0L), null.ok = FALSE, info = NULL, label = vname(x))
x |
[any] |
contains |
[ |
null.ok |
[ |
.var.name |
[ |
add |
[ |
info |
[character(1)] |
label |
[ |
Depending on the function prefix:
If the check is successful, the functions
assertEnvironment
/assert_environment
return
x
invisibly, whereas
checkEnvironment
/check_environment
and
testEnvironment
/test_environment
return
TRUE
.
If the check is not successful,
assertEnvironment
/assert_environment
throws an error message,
testEnvironment
/test_environment
returns FALSE
,
and checkEnvironment
returns a string with the error message.
The function expect_environment
always returns an
expectation
.
Other basetypes: checkArray
,
checkAtomicVector
,
checkAtomic
, checkCharacter
,
checkComplex
, checkDataFrame
,
checkDate
, checkFactor
,
checkFunction
,
checkIntegerish
,
checkInteger
, checkList
,
checkLogical
, checkMatrix
,
checkNull
, checkNumeric
,
checkPOSIXct
, checkVector
ee = as.environment(list(a = 1)) testEnvironment(ee) testEnvironment(ee, contains = "a")