Skip to contents

Check Whole Number

Source: R/chk-whole-number.R
chk_whole_number.Rd

Checks if non-missing integer scalar or double equivalent using

vld_number(x) && (is.integer(x) || vld_true(all.equal(x, trunc(x))))

Pass: 1, 2L, 1e10, -Inf

Fail: "a", 1:3, NA_integer_, log(10)

Usage

chk_whole_number(x, x_name = NULL)

vld_whole_number(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_number(): Validate Whole Number

See also

is.integer()

vld_true()

vld_number()

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

Other scalar_checker: chk_complex_number()

Other whole_number_checkers: chk_count(), chk_whole_numeric()

Examples

# chk_whole_number
chk_whole_number(2)
try(chk_whole_number(1.1))
#> Error in eval(expr, envir) : 
#>   `1.1` must be a whole number (non-missing integer scalar or double equivalent).
# vld_whole_number
vld_whole_number(2)
#> [1] TRUE