chk_gt: Check Greater Than

In chk: Check User-Supplied Function Arguments

Check Greater Than

Description

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

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

Usage

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

vld_gt(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_gt(): Validate Greater Than

See Also

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

Examples

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

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