Check scalar arg in x

Check if scalar arg %in% x.

Usage

check_scalar_arg_in_x(arg, x, signal = "error", msg = NULL, call. = FALSE)

Arguments

arg

(object)
The argument to check.

x

(Atomic vector)
Scalar arg must match one value in x.

signal

(string: c("error", "warning", "message"))
Must be one of "error", "warning", or "message". "error" (default) calls base::stop() to signal an error message. "warning" calls base::warning() to signal a warning message. "message" calls base::message() to signal a message.

msg

(string or NULL: NULL)
A string that replaces the default message. Set as NULL to use the default message.

call.

(Scalar logical: c(FALSE, TRUE))
Passed to stop() or warning(). The default msg includes it's own formatted call, hence call. should be FALSE (default). If you insert your own msg, then you may want call. = TRUE.

Value

invisible(arg) or condition determined by argument signal.

See also

Other check_relation: check_all_arg_in_x(), check_all_x_in_arg(), check_any_arg_in_x(), check_any_x_in_arg(), check_equals(), check_finite(), check_length_equals(), check_lt(), check_monotonic_decreasing(), check_names_in_arg(), check_range(), check_strict_decreasing(), check_unique()

Examples

#----------------------------------------------------------------------------
# check_scalar_arg_in_x() examples
#----------------------------------------------------------------------------
library(bkcheck)

f <- function(x) {
  chr <- c("a", "b", "c")
  x |>
    check_scalar_arg_in_x(chr)
}

f("a")
try(f("d"))
#> Error : Argument `x` is 'd' but must be exactly one of:
#> 'a', 'b', or 'c'
#> 
#> Call: f(x = "d")