check_pos_integer_scalar: Check positive integer scalar

In rtemis.core: Core Utilities for the 'rtemis' Ecosystem

Check positive integer scalar

Description

Check positive integer scalar

Usage

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

Arguments

x	Numeric: Value to check. Must be a single non-NA whole number greater than zero.
arg_name	Character: Argument name to use in error messages.

Details

Accepts any single numeric value that is a whole number strictly greater than zero. Integer-typed inputs (1L) and double-typed whole numbers (1, 100) are both accepted for user convenience.

Value

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

Author(s)

EDG

Examples

check_pos_integer_scalar(1L)
check_pos_integer_scalar(10)
# Throw error:
try(check_pos_integer_scalar(0))
try(check_pos_integer_scalar(-1L))
try(check_pos_integer_scalar(1.5))

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