chk_length: Check Length

In chk: Check User-Supplied Function Arguments

Check Length

Description

Checks length is a particular value or range using

length(x) >= length && length(x) <= upper

Usage

chk_length(x, length = 1L, upper = length, x_name = NULL)

vld_length(x, length = 1L, upper = length)

Arguments

x	The object to check.
length	A count of the length.
upper	A count of the max length.
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_length(): Validate Length

See Also

length(), check_length(), check_dim()

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

Other length_checkers: chk_compatible_lengths()

Examples

# chk_length
chk_length("text")
try(vld_length("text", length = 2))
# vld_length
vld_length(2:1, 2)
vld_length(2:1, 1)

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