check_names: Check Names

Description Usage Arguments Value See Also Examples

View source: R/check-names.R

Description

Checks the names of an object.

Usage

1
2
3
4
5
6
7
check_names(
  x,
  names = character(0),
  exclusive = FALSE,
  order = FALSE,
  x_name = NULL
)

Arguments

x

The object to check.

names

A character vector of the required names.

exclusive

A flag specifying whether x must only contain the required names.

order

A flag specifying whether the order of the required names in x must match the order in names.

x_name

A string of the name of object x or NULL.

Value

An informative error if the test fails.

See Also

Other check: check_data(), check_dim(), check_dirs(), check_files(), check_key(), check_values()

Examples

1
2
3
4
x <- c(x = 1, y = 2)
check_names(x, c("y", "x"))
try(check_names(x, c("y", "x"), order = TRUE))
try(check_names(x, "x", exclusive = TRUE))

chk documentation built on July 25, 2020, 9:07 a.m.