chk_lt: Check Less Than

In chk: Check User-Supplied Function Arguments

Check Less Than

Description

Checks if all non-missing values are less than value using

all(x[!is.na(x)] < value)

Usage

chk_lt(x, value = 0, x_name = NULL)

vld_lt(x, value = 0)

Arguments

x	The object to check.
value	A non-missing scalar of a value.
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_lt(): Validate Less Than

See Also

Other chk_ranges: chk_gt(), chk_gte(), chk_lte(), chk_range()

Examples

# chk_lt
chk_lt(-0.1)
try(chk_lt(c(-0.1, 0.2)))
# vld_lt
vld_lt(numeric(0))
vld_lt(0)
vld_lt(-0.1)
vld_lt(c(-0.1, -0.2, NA))
vld_lt(c(-0.1, 0.2))
vld_lt(c(-0.1, 0.2), value = 1)
vld_lt("a", value = "b")

chk documentation built on Sept. 11, 2024, 7:34 p.m.