check_optional_bounded_double_scalar: Check optional double scalar within bounds

View source: R/check.R

check_optional_bounded_double_scalarR Documentation

Check optional double scalar within bounds

Description

Check optional double scalar within bounds

Usage

check_optional_bounded_double_scalar(
  x,
  lower = -Inf,
  upper = Inf,
  lower_open = FALSE,
  upper_open = FALSE,
  arg_name = deparse(substitute(x))
)

Arguments

x

Optional Numeric: Value to check. Must be NULL or a single finite non-NA number within bounds.

lower

Numeric scalar: Lower bound.

upper

Numeric scalar: Upper bound.

lower_open

Logical scalar: If TRUE, the lower bound is exclusive.

upper_open

Logical scalar: If TRUE, the upper bound is exclusive.

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_bounded_double_scalar(NULL)
check_optional_bounded_double_scalar(0.7, lower = 0, upper = 2)
# Throw error:
try(check_optional_bounded_double_scalar(5, lower = 0, upper = 2))

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