Checks the names of an object as returned by the names() function.
The function can check the order of the names and whether other names are permitted.
check_names(
x,
names = character(0),
exclusive = FALSE,
order = FALSE,
unique = FALSE,
complete = TRUE,
x_name = substitute(x),
error = TRUE
)The object to check.
A character vector of the names.
A flag indicating whether other names are not permitted.
A flag indicating whether the object names have to occur in the same order as names.
A flag indicating whether all the object names have to be unique.
A flag indicating whether all the possible names have to be represented.
A string of the name of the object x.
A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.
An invisible copy of x (if it doesn't throw an error).
vec <- c(x = 1, y = 2, z = 0)
check_names(vec, c("y", "x"), error = FALSE)
#> Warning: `check_names()` was deprecated in checkr 0.5.1.
#> Please use `chk::check_names()` instead.
check_names(vec, c("y", "x"), exclusive = TRUE, error = FALSE)
#> Warning: `check_names()` was deprecated in checkr 0.5.1.
#> Please use `chk::check_names()` instead.
#> Warning: vec names must not include 'z'
check_names(vec, c("y", "x"), order = TRUE, error = FALSE)
#> Warning: `check_names()` was deprecated in checkr 0.5.1.
#> Please use `chk::check_names()` instead.
#> Warning: vec names must include 'y' and 'x' in that order
check_names(vec, c("a"), error = FALSE)
#> Warning: `check_names()` was deprecated in checkr 0.5.1.
#> Please use `chk::check_names()` instead.
#> Warning: vec names must include 'a'