chk_factor: Check Factor

In chk: Check User-Supplied Function Arguments

Check Factor

Description

Checks if factor using

is.factor(x)

Usage

chk_factor(x, x_name = NULL)

vld_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_factor(): Validate Factor

See Also

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

Examples

# chk_factor
chk_factor(factor("1"))
try(chk_factor("1"))
# vld_factor
vld_factor(factor("1"))
vld_factor(factor(0))
vld_factor("1")
vld_factor(1L)

chk documentation built on Oct. 6, 2023, 9:06 a.m.