chk_all_equivalent: Check All Equivalent

In chk: Check User-Supplied Function Arguments

Check All Equivalent

Description

Checks all elements in x equivalent using

length(x) < 2L || all(vapply(x, vld_equivalent, TRUE, y = x[[1]], tolerance = tolerance))

Usage

chk_all_equivalent(x, tolerance = sqrt(.Machine$double.eps), x_name = NULL)

vld_all_equivalent(x, tolerance = sqrt(.Machine$double.eps))

Arguments

x	The object to check.
tolerance	A non-negative numeric scalar.
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_all_equivalent(): Validate All Equivalent

See Also

Other chk_alls: chk_all(), chk_all_equal(), chk_all_identical()

Examples

# chk_all_equivalent
chk_all_equivalent(c(1, 1.00000001))
try(chk_all_equivalent(c(1, 1.0000001)))
chk_all_equivalent(list(c(x = 1), c(x = 1)))
chk_all_equivalent(list(c(x = 1), c(y = 1)))
# vld_all_equivalent
vld_all_equivalent(c(x = 1, y = 1))

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