Skip to contents

Assert that an object is a single positive number

Source: R/core.R
assert_scalar_positive.Rd

Checks that x is a single, finite, positive number (greater than zero). NA, NaN, Inf, zero, and negative values are all rejected. The positive-and-finite counterpart of assert_scalar_count().

Usage

assert_scalar_positive(
  x,
  null_ok = FALSE,
  arg = rlang::caller_arg(x),
  call = rlang::caller_env()
)

Arguments

x

Object to check.

null_ok

Single logical. If TRUE, a NULL value passes the check without error. Use this for optional arguments that default to NULL. Defaults to FALSE, so NULL is rejected unless you opt in.

arg

Name used to refer to x in error messages. Defaults to the name of the expression passed as x.

call

Environment used as the error's call context. Defaults to the calling function, so errors point at the user's code.

Value

The input x, invisibly.

Examples

assert_scalar_positive(42)
assert_scalar_positive(0.5)