chk_equal: Check Equal

In chk: Check User-Supplied Function Arguments

Check Equal

Description

Checks if is equal (identical within tolerance) to y using

vld_true(all.equal(x, y, tolerance))

Usage

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

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

Arguments

x	The object to check.
y	An object to check against.
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_equal(): Validate Equal

See Also

Other chk_equals: chk_equivalent(), chk_identical()

Examples

# chk_equal
chk_equal(1, 1.00000001)
try(chk_equal(1, 1.0000001))
chk_equal(1, 1L)
chk_equal(c(x = 1), c(x = 1L))
try(chk_equal(c(x = 1), c(y = 1L)))
vld_equal(1, 1.00000001)

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