check_optional_pos_integer_scalar: Check optional positive integer scalar

View source: R/check.R

check_optional_pos_integer_scalarR Documentation

Check optional positive integer scalar

Description

Check optional positive integer scalar

Usage

check_optional_pos_integer_scalar(x, arg_name = deparse(substitute(x)))

Arguments

x

Optional Numeric: Value to check. Must be NULL or a single non-NA whole number greater than zero.

arg_name

Character: Argument name to use in error messages.

Value

Called for side effects. Throws an error if checks fail.

Author(s)

EDG

Examples

check_optional_pos_integer_scalar(NULL)
check_optional_pos_integer_scalar(5L)
# Throw error:
try(check_optional_pos_integer_scalar(0))

rtemis.core documentation built on Sept. 20, 2026, 9:06 a.m.