check_colnames: Check Colnames

In poissonconsulting/checkr: Check the Properties of Common R Objects

Check Colnames

Description

Checks the column names of a data frame as returned by the colnames() function. The function can check the order of the columns and whether other columns are permitted.

Usage

check_colnames(
  x,
  colnames = character(0),
  exclusive = FALSE,
  order = FALSE,
  x_name = substitute(x),
  error = TRUE
)

Arguments

x	The data to check.
colnames	A character vector of the column names.
exclusive	A flag indicating whether other columns are not permitted.
order	A flag indicating whether the columns have to occur in the same order as colnames.
x_name	A string of the name of the object x.
error	A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.

Value

An invisible copy of x (if it doesn't throw an error).

See Also

check_missing_colnames and check_data

Examples

data <- data.frame(x = 1, y = 2, z = 0)
check_colnames(data, c("y", "x"), error = FALSE)
check_colnames(data, c("y", "x"), exclusive = TRUE, error = FALSE)
check_colnames(data, c("y", "x"), order = TRUE, error = FALSE)
check_colnames(data, c("a"), error = FALSE)

poissonconsulting/checkr documentation built on Oct. 18, 2023, 9:39 p.m.