chk_character_or_factor: Check Character or Factor

In chk: Check User-Supplied Function Arguments

Check Character or Factor

Description

Checks if character or factor using

is.character(x) || is.factor(x)

Usage

chk_character_or_factor(x, x_name = NULL)

vld_character_or_factor(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_or_factor(): Validate Character or Factor

See Also

Other chk_typeof: chk_character(), chk_count(), chk_double(), chk_environment(), chk_factor(), chk_integer(), chk_list(), chk_logical()

Examples

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

chk documentation built on Sept. 11, 2024, 7:34 p.m.