chk_range: Checks range of non-missing values

In chk: Check User-Supplied Function Arguments

Checks range of non-missing values

Description

Checks all non-missing values fall within range using

If inclusive

all(x[!is.na(x)] >= range[1] & x[!is.na(x)] <= range[2])

else

all(x[!is.na(x)] > range[1] & x[!is.na(x)] < range[2])

Usage

chk_range(x, range = c(0, 1), inclusive = TRUE, x_name = NULL)

vld_range(x, range = c(0, 1), inclusive = TRUE)

Arguments

x	The object to check.
range	A non-missing sorted vector of length 2 of the lower and upper permitted values.
inclusive	A flag specifying whether the range is exclusive.
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_range(): Validate Range

See Also

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

Examples

# chk_range
chk_range(0)
try(chk_range(-0.1))
# vld_range
vld_range(numeric(0))
vld_range(0)
vld_range(-0.1)
vld_range(c(0.1, 0.2, NA))
vld_range(c(0.1, 0.2, NA), range = c(0, 1))

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