validate_count {checkthat}

Validate a Count Value

Description

This function validates whether a numeric value is a valid count (integer of zero or greater).

Usage

validate_count(x, include_zero = TRUE)

Arguments

x

Numeric value to validate as a count.

include_zero

Logical, whether to include zero as a valid count.

Value

TRUE if x is a valid count, otherwise it throws an error.

See Also

is_count, is_proportion, validate_proportion, is_integerlike

Examples

validate_count(0) # TRUE
validate_count(3) # TRUE
try(validate_count(0, include_zero = FALSE)) # Error: Not a valid count
try(validate_count(-1)) # Error: Not a valid count value.