check_integer_scalar: Check integer scalar

View source: R/check.R

check_integer_scalarR Documentation

Check integer scalar

Description

Check integer scalar

Usage

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

Arguments

x

Numeric: Value to check. Must be a single non-NA whole number.

arg_name

Character: Argument name to use in error messages.

Details

Accepts any single numeric value that is a whole number. 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_integer_scalar(5L)
check_integer_scalar(100)
# Throw error:
try(check_integer_scalar(1.5))
try(check_integer_scalar(NA_integer_))

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