input_check_response: Standardized response to input check
In oeli: Some Utilities for Developing Data Science Software

input_check_response

R Documentation

Standardized response to input check

Description

This function provides a standardized response to input checks, ensuring consistency.

Usage

input_check_response(
  check,
  var_name = NULL,
  error = TRUE,
  prefix = "Input {.var {var_name}} is bad:"
)

Arguments

`check`	[`TRUE` \| `character(1)` \| `list()`] Matches the return value of the `⁠check*⁠` functions from the `{checkmate}` package, i.e., either `TRUE` if the check was successful, or a `character` (the error message) else. Can also be a `list` of multiple such values for alternative criteria, where at least one must be `TRUE` for a successful check.
`var_name`	[`NULL` \| `character(1)`] Optionally specifies the name of the input being checked. This name will be used for the default value of the `prefix` argument.
`error`	[`logical(1)`] If `check` is not `TRUE` (or no element in `check` is `TRUE`, if `check` is a `list`), throw an error?
`prefix`	[`character(1)`] A prefix for the thrown error message, only relevant if `error` is `TRUE`.

Value

TRUE if check is TRUE (or any element in check is TRUE, if check is a list) . Else, depending on error:

If error is TRUE, throws an error.
If error is FALSE, returns FALSE.

Examples

x <- "1"
y <- 1

### check is successful
input_check_response(
  check = checkmate::check_character(x),
  var_name = "x",
  error = TRUE
)

### alternative checks
input_check_response(
  check = list(
    checkmate::check_character(x),
    checkmate::check_character(y)
  ),
  var_name = "x",
  error = TRUE
)

### standardized check response
## Not run: 
input_check_response(
  check = checkmate::check_character(y),
  var_name = "y",
  error = TRUE
)

input_check_response(
  check = list(
    checkmate::check_flag(x),
    checkmate::check_character(y)
  ),
  var_name = "y",
  error = TRUE
)

## End(Not run)

oeli documentation built on Aug. 18, 2025, 5:24 p.m.