chk_wnum: Check Whole Numeric Scalar

In chk: Check User-Supplied Function Arguments

Check Whole Numeric Scalar

Description

Checks if whole numeric scalar using

is.numeric(x) && length(x) == 1L && (is.integer(x) || vld_true(all.equal(x, trunc(x))))

Usage

chk_wnum(x, x_name = NULL)

vld_wnum(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_wnum(): Validate Whole Numeric Scalar

  

See Also

Other deprecated: chk_chr(), chk_dbl(), chk_deprecated

Examples

# chk_wnum
chk_wnum(1)
try(chk_wnum(1.1))
# vld_wnum
vld_wnum(1)
vld_wnum(double(0))
vld_wnum(NA_real_)
vld_wnum(c(1, 1))
vld_wnum(1L)

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