chk: chk_wnum – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

chk

chk_wnum

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.

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

Functions

vld_wnum: Validate Double

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

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