Check Integer — chk_integer • chk

Checks if integer using

is.integer(x)

Usage

chk_integer(x, x_name = NULL)

vld_integer(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_integer(): Validate Integer

See also

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

Other data_type_checkers: chk_character(), chk_character_or_factor(), chk_complex(), chk_double(), chk_environment(), chk_logical(), chk_numeric(), chk_raw()

Examples

# chk_integer
chk_integer(1L)
try(chk_integer(1))
#> Error in eval(expr, envir) : `1` must be integer.
# vld_integer
vld_integer(1L)
#> [1] TRUE
vld_integer(matrix(1:4, nrow = 2L))
#> [1] TRUE
vld_integer(integer(0))
#> [1] TRUE
vld_integer(NA_integer_)
#> [1] TRUE
vld_integer(1)
#> [1] FALSE
vld_integer(TRUE)
#> [1] FALSE