chk_array: Check Array

In chk: Check User-Supplied Function Arguments

Check Array

Description

Checks if is an array using

is.array(x)

Usage

chk_array(x, x_name = NULL)

vld_array(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_array(): Validate Array

See Also

is.array()

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

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

Examples

# chk_array
chk_array(array(1))
try(chk_array(matrix(1)))

# vld_array
vld_array(1)
vld_array(array(1))

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