chk_character: Check Character

In chk: Check User-Supplied Function Arguments

Check Character

Description

Checks if character using

is.character(x)

Usage

chk_character(x, x_name = NULL)

vld_character(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_character(): Validate Character

See Also

is.character()

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

Other data_type_checkers: chk_character_or_factor(), chk_complex(), chk_double(), chk_environment(), chk_integer(), chk_logical(), chk_numeric(), chk_raw()

Examples

# chk_character
chk_character("1")
try(chk_character(1))
# vld_character
vld_character("1")
vld_character(matrix("a"))
vld_character(character(0))
vld_character(NA_character_)
vld_character(1)
vld_character(TRUE)
vld_character(factor("text"))

chk documentation built on April 3, 2025, 8:50 p.m.