chk_gte: Check Greater Than or Equal To

In chk: Check User-Supplied Function Arguments

Check Greater Than or Equal To

Description

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

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

Usage

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

vld_gte(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_gte(): Validate Greater Than or Equal To

See Also

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

Examples

# chk_gte
chk_gte(0)
try(chk_gte(-0.1))
# vld_gte
vld_gte(numeric(0))
vld_gte(0)
vld_gte(-0.1)
vld_gte(c(0.1, 0.2, NA))
vld_gte(c(0.1, 0.2, NA), value = 1)

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