check_chr: Check String

In poissonconsulting/checkr: Check the Properties of Common R Objects

Check String

Description

Checks if object is a string (non-missing character scalar with no attributes including names).

Usage

check_chr(x, coerce = FALSE, x_name = substitute(x), error = TRUE)

check_string(x, coerce = FALSE, x_name = substitute(x), error = TRUE)

Arguments

x	The object to check.
coerce	A flag indicating whether to coerce a factor scalar to a string and drop attributes including names.
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_scalar()

Examples

check_chr(1, error = FALSE)
check_chr("1", error = FALSE)
check_chr(c("1", "2"), error = FALSE)

poissonconsulting/checkr documentation built on Jan. 19, 2025, 12:37 p.m.