check_optional_prob_scalar: Check optional probability scalar

View source: R/check.R

check_optional_prob_scalarR Documentation

Check optional probability scalar

Description

Check optional probability scalar

Usage

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

Arguments

x

Optional Numeric: Value to check. Must be NULL or a single finite number in [0, 1].

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_prob_scalar(NULL)
check_optional_prob_scalar(0.5)
# Throw error:
try(check_optional_prob_scalar(2.0))

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