Check Count — chk_count • chk

Checks if non-negative whole number using

vld_whole_number(x) && x >= 0

Usage

chk_count(x, x_name = NULL)

vld_count(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_count(): Validate Count

See also

vld_whole_number()

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

Other scalar_checkers: chk_date(), chk_date_time(), chk_false(), chk_flag(), chk_lgl(), chk_scalar(), chk_string(), chk_true(), chk_tz()

Other whole_number_checkers: chk_whole_number(), chk_whole_numeric()

Examples

# chk_count
chk_count(1)
try(chk_count(1.5))
#> Error in eval(expr, envir) : 
#>   `1.5` must be a count (non-negative non-missing integer scalar or double equivalent).
# vld_count
vld_count(1)
#> [1] TRUE
vld_count(0L)
#> [1] TRUE
vld_count(-1)
#> [1] FALSE
vld_count(0.5)
#> [1] FALSE