Check Int

Checks if x is a int (non-missing integer scalar with no attributes including names).

Usage

check_int(x, coerce = FALSE, x_name = substitute(x), error = TRUE)

Arguments

x

The object to check.

coerce

A flag indicating whether to coerce a numeric (dbl) whole number to an int and drop attributes including names.

x_name

A string of the name of the object x.

error

A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.

Value

An invisible copy of x (if it doesn't throw an error).

See also

check_scalar()

Examples

check_int(1, error = FALSE)
#> Warning: `check_int()` was deprecated in checkr 0.5.1.
#> ℹ Please use `chk::chk_integer()` instead.
#> Warning: 1 must be class integer
#> Warning: 1 must inherit from classes 'integer' in that order
check_int(1L, error = FALSE)
check_int(1:2, error = FALSE)
#> Warning: 1:2 must have 1 element