is_count: Check if a Numeric Value is a Count

View source: R/utils-typechecks.R

is_countR Documentation

Check if a Numeric Value is a Count

Description

This function checks if a numeric value is a count, meaning it is integer-like and non-negative.

Usage

is_count(x, include_zero = TRUE)

Arguments

x

Numeric value to check.

include_zero

Logical, whether to include zero as a valid count.

Value

TRUE if x is a count, otherwise FALSE.

See Also

is_proportion, is_integerlike, validate_count, validate_proportion

Examples

is_count(0) # TRUE
is_count(3) # TRUE
is_count(0, include_zero = FALSE) # FALSE
is_count(-1) # FALSE
is_count(1.5) # FALSE

checkthat documentation built on Sept. 13, 2023, 1:06 a.m.