Skip to contents

Check Valid Name

Source: R/chk-valid-name.R
chk_valid_name.Rd

Checks if valid name using

identical(make.names(x[!is.na(x)]), as.character(x[!is.na(x)]))

Usage

chk_valid_name(x, x_name = NULL)

vld_valid_name(x)

Arguments

x

The object to check.

x_name

A string of the name of object x or NULL.

Value

The chk_ function throws an informative error if the test fails or returns the original object if successful so it can used in pipes.

The vld_ function returns a flag indicating whether the test was met.

Functions

  • vld_valid_name(): Validate Valid Name

See also

identical()

make.names()

For more details about the use of this function, please read the article vignette("chk-families").

Other name_checkers: chk_named()

Examples

# chk_valid_name
chk_valid_name("text")
try(chk_valid_name(".1"))
#> Error in eval(expr, envir) : `".1"` must be valid name.
# vld_valid_name
vld_valid_name(".1")
#> [1] FALSE