check_named: Check Named

View source: R/named.R

check_namedR Documentation

Check Named

Description

Checks whether an object is named.

Usage

check_named(
  x,
  nchar = c(0L, chk_max_int()),
  pattern = ".*",
  regex = pattern,
  unique = FALSE,
  x_name = substitute(x),
  error = TRUE
)

Arguments

x

The object to check.

nchar

A count or count range of the number of characters.

pattern

A string of the regular expression that must match all names.

regex

A string of the regular expression that must match all names.

unique

A flag indicating whether the names must be unique.

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_unnamed, check_names and check_missing_names

Examples

check_named(2, error = FALSE)
x <- 1
names(x) <- "y"
check_named(x, error = FALSE)

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