checkFunction {checkmate} | R Documentation |
Check if an argument is a function
checkFunction(x, args = NULL, ordered = FALSE, nargs = NULL, null.ok = FALSE) check_function(x, args = NULL, ordered = FALSE, nargs = NULL, null.ok = FALSE) assertFunction(x, args = NULL, ordered = FALSE, nargs = NULL, null.ok = FALSE, .var.name = vname(x), add = NULL) assert_function(x, args = NULL, ordered = FALSE, nargs = NULL, null.ok = FALSE, .var.name = vname(x), add = NULL) testFunction(x, args = NULL, ordered = FALSE, nargs = NULL, null.ok = FALSE) test_function(x, args = NULL, ordered = FALSE, nargs = NULL, null.ok = FALSE) expect_function(x, args = NULL, ordered = FALSE, nargs = NULL, null.ok = FALSE, info = NULL, label = vname(x))
x |
[any] |
args |
[ |
ordered |
[ |
nargs |
[ |
null.ok |
[ |
.var.name |
[ |
add |
[ |
info |
[character(1)] |
label |
[ |
Depending on the function prefix:
If the check is successful, the functions
assertFunction
/assert_function
return
x
invisibly, whereas
checkFunction
/check_function
and
testFunction
/test_function
return
TRUE
.
If the check is not successful,
assertFunction
/assert_function
throws an error message,
testFunction
/test_function
returns FALSE
,
and checkFunction
returns a string with the error message.
The function expect_function
always returns an
expectation
.
Other basetypes: checkArray
,
checkAtomicVector
,
checkAtomic
, checkCharacter
,
checkComplex
, checkDataFrame
,
checkDate
, checkEnvironment
,
checkFactor
, checkIntegerish
,
checkInteger
, checkList
,
checkLogical
, checkMatrix
,
checkNull
, checkNumeric
,
checkPOSIXct
, checkVector
testFunction(mean) testFunction(mean, args = "x")