chk_whole_numeric: Check Whole Numeric

In chk: Check User-Supplied Function Arguments

Check Whole Numeric

Description

Checks if integer vector or double equivalent using

is.integer(x) || (is.double(x) && vld_true(all.equal(x, as.integer(x))))

Usage

chk_whole_numeric(x, x_name = NULL)

vld_whole_numeric(x)

Arguments

x	The object to check.
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_whole_numeric(): Validate Whole Numeric

See Also

is.integer()

is.double()

vld_true()

all.equal()

For more details about the use of this function, please read the article vignette("chk-families").

Other whole_number_checkers: chk_count(), chk_whole_number()

Examples

# chk_whole_numeric
chk_whole_numeric(1)
try(chk_whole_numeric(1.1))
# vld_whole_numeric
vld_whole_numeric(1)
vld_whole_numeric(NA_real_)
vld_whole_numeric(1:2)
vld_whole_numeric(double(0))
vld_whole_numeric(TRUE)
vld_whole_numeric(1.5)

chk documentation built on April 3, 2025, 8:50 p.m.