input_check_response {oeli} | R Documentation |
Standardized response to an input check
Description
This function provides standardized responses to input checks, ensuring consistency.
Usage
input_check_response(
check,
var_name = NULL,
error = TRUE,
prefix = "Input {.var {var_name}} is bad:"
)
Arguments
check |
[ |
var_name |
[ |
error |
[ |
prefix |
[ |
Value
TRUE
if check
is TRUE
. If check
is not TRUE
, depending on error
:
If
error
isTRUE
, throws an error.If
error
isFALSE
, returnsFALSE
.
See Also
Other package helpers:
Dictionary
,
Storage
,
identical_structure()
,
match_arg()
,
package_logo()
,
print_data.frame()
,
print_matrix()
,
renv_development_packages()
,
system_information()
,
unexpected_error()
,
user_confirm()
Examples
x <- "1"
y <- 1
### check is successful
input_check_response(
check = checkmate::check_character(x),
var_name = "x",
error = TRUE
)
### standardized check response
## Not run:
input_check_response(
check = checkmate::check_character(y),
var_name = "y",
error = TRUE
)
## End(Not run)