check_noneg_int: Check Non-Negative Int

In poissonconsulting/checkr: Check the Properties of Common R Objects

Check Non-Negative Int

Description

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

Usage

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

Arguments

x	The object to check.
coerce	A flag indicating whether to coerce a non-negative numeric (dbl) whole number to a count 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_int

Examples

check_noneg_int(1, error = FALSE)
check_noneg_int(0L, error = FALSE)
check_noneg_int(1L, error = FALSE)

poissonconsulting/checkr documentation built on Oct. 18, 2023, 9:39 p.m.