assert_greater_than {assertions}

Assert input is greater than some minimum value

Description

Assert a number is greater than a specified minimum value. To check all numbers in a vector / matrix are above a minimum value, see assert_all_greater_than()

Usage

assert_greater_than(
  x,
  minimum,
  msg = NULL,
  call = rlang::caller_env(),
  arg_name = NULL
)

Arguments

x

An object to check

minimum

The minimum value to compare against (number)

msg

A character string containing the error message to display if x is not greater than the specified minimum value (string)

call

Only relevant when pooling assertions into multi-assertion helper functions. See cli_abort for details.

arg_name

Advanced use only. Name of the argument passed (default: NULL, will automatically extract arg_name).

Value

invisible(TRUE) if x is greater than the specified minimum value, otherwise aborts with the error message specified by msg

Examples

try({
assert_greater_than(3, 2) # Passes
assert_greater_than(3, 2) # Passes
assert_greater_than(c(2,3,4), 1) # Throws error (Must be a number)
assert_greater_than('A', 1) # Throws error (Must be a number)
assert_greater_than(2, 3, msg = "custom error message") # Throws custom error
})