chk_list: Check List

In chk: Check User-Supplied Function Arguments

Check List

Description

Checks if is a list using

is.list(x)

Usage

chk_list(x, x_name = NULL)

vld_list(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_list(): Validate List

See Also

is.list()

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

Other data_structure_checkers: chk_array(), chk_atomic(), chk_matrix(), chk_vector()

Examples

# chk_list
chk_list(list())
try(chk_list(1))
# vld_list
vld_list(list())
vld_list(list(x = 1))
vld_list(mtcars)
vld_list(1)
vld_list(NULL)

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