check_count: Check Count

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

Check Count

Description

Checks if an object is a count (non-negative integer or if coerce = TRUE non-negative numeric whole number).

Usage

check_count(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_scalar

Examples

check_count(-1L, error = FALSE)
check_count(1L, error = FALSE)
check_count(1, error = FALSE)
check_count(1, coerce = TRUE, error = FALSE)
check_count(1.01, coerce = TRUE, error = FALSE)

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