Checks that x is a data frame whose column names are exactly columns,
as a set. By default order does not matter.
Usage
assert_column_names(
x,
columns,
ordered = FALSE,
null_ok = FALSE,
arg = rlang::caller_arg(x),
call = rlang::caller_env()
)Arguments
- x
Object to check.
- columns
Character vector of the exact column names expected.
- ordered
Single logical: if
TRUE, the columns must also appear in the given order. Defaults toFALSE.- null_ok
Single logical. If
TRUE, aNULLvalue passes the check without error. Use this for optional arguments that default toNULL. Defaults toFALSE, soNULLis rejected unless you opt in.- arg
Name used to refer to
xin error messages. Defaults to the name of the expression passed asx.- call
Environment used as the error's call context. Defaults to the calling function, so errors point at the user's code.
Examples
assert_column_names(data.frame(a = 1, b = 2), c("a", "b"))
