chk: chk_dbl – R documentation

Pricing

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

Get Started for Free

Documentation

chk

chk_dbl

Check Double Scalar

Description

Checks if double scalar using

is.double(x) && length(x) == 1L

Usage

chk_dbl(x, x_name = NULL)

vld_dbl(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_dbl: Validate Double

Examples

# chk_dbl
chk_dbl(1)
try(chk_dbl(1L))
# vld_dbl
vld_dbl(1)
vld_dbl(double(0))
vld_dbl(NA_real_)
vld_dbl(c(1,1))
vld_dbl(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