chk_string: Check String

In chk: Check User-Supplied Function Arguments

Check String

Description

Checks if string

is.character(x) && length(x) == 1L && !anyNA(x)

Usage

chk_string(x, x_name = NULL)

vld_string(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_string(): Validate String

See Also

length()

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

Other scalar_checkers: chk_count(), chk_date(), chk_date_time(), chk_false(), chk_flag(), chk_lgl(), chk_scalar(), chk_true(), chk_tz()

Examples

# chk_string
chk_string("1")
try(chk_string(1))
# vld_string
vld_string("1")
vld_string("")
vld_string(1)
vld_string(NA_character_)
vld_string(c("1", "1"))

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