Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

chk_range

Checks range of non-missing values


Description

Checks all non-missing values fall within range using

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

Usage

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

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

Arguments

x

The object to check.

range

A non-missing sorted vector of length 2 of the lower and upper permitted values.

x_name

A string of the name of object x or NULL.

Value

The chk_ function throws an informative error if the test fails.

The vld_ function returns a flag indicating whether the test was met.

Functions

  • vld_range: Validate Range

See Also

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

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

Check User-Supplied Function Arguments

v0.5.1
MIT + file LICENSE
Authors
Joe Thorley [aut, cre] (<https://orcid.org/0000-0002-7683-4592>), Kirill Müller [aut] (<https://orcid.org/0000-0002-1416-3412>), Ayla Pearson [ctb] (<https://orcid.org/0000-0001-7388-1222>), Poisson Consulting [cph, fnd]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.