chk_lte: Check Less Than or Equal To

In chk: Check User-Supplied Function Arguments

Check Less Than or Equal To

Description

Checks if all non-missing values are less than or equal to y using

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

Usage

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

vld_lte(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_lte(): Validate Less Than or Equal To

See Also

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

Examples

# chk_lte
chk_lte(0)
try(chk_lte(0.1))
# vld_lte
vld_lte(numeric(0))
vld_lte(0)
vld_lte(0.1)
vld_lte(c(-0.1, -0.2, NA))
vld_lte(c(-0.1, -0.2, NA), value = -1)

chk documentation built on Oct. 6, 2023, 9:06 a.m.