Check names

Check if arg has specified names.

Usage

check_names_in_arg(arg, names, signal = "error", msg = NULL, call. = FALSE)

Arguments

arg

(object)
The argument to check.

names

(character)
The names that should match names(arg).

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_range(), check_scalar_arg_in_x(), check_strict_decreasing(), check_unique()

Examples

#----------------------------------------------------------------------------
# check_names_in_arg() examples
#----------------------------------------------------------------------------
library(bkcheck)

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

f(c(a = 1, b = 2))
f(data.frame(a = 1, b = 2))
f(list(a = 1, b = 2))

try(f(1:2))
#> Error : Argument `x` must have all required names.
#> 
#> Missing names: 'a', 'b'
#> Required names: 'a', 'b'
#> 
#> Call: f(x = 1:2)
try(f(c(a = 1, 2)))
#> Error : Argument `x` must have all required names.
#> 
#> Missing names: 'b'
#> Required names: 'a', 'b'
#> 
#> Call: f(x = c(a = 1, 2))
try(f(list(a = 1, 2)))
#> Error : Argument `x` must have all required names.
#> 
#> Missing names: 'b'
#> Required names: 'a', 'b'
#> 
#> Call: f(x = list(a = 1, 2))