check_length: Check Length

In poissonconsulting/checkr: Check the Properties of Common R Objects

Check Length

Description

Checks whether the number of elements in an object is an exact number, within a range or 0 vs positive.

Usage

check_length(x, length = TRUE, x_name = substitute(x), error = TRUE)

Arguments

x	The object to check.
length	A flag indicating whether x should have elements (versus no elements) or a missing value indicating no requirements or a count or count range of the number of elements or a count vector of the permitted number of elements.
x_name	A string of the name of the object x.
error	A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.

Value

An invisible copy of x (if it doesn't throw an error).

See Also

check_vector, check_list and check_data

Examples

check_length(2)
check_length(character(0), length = 0)
check_length(NULL, error = FALSE)
check_length(list(), error = FALSE)

poissonconsulting/checkr documentation built on Oct. 18, 2023, 9:39 p.m.