Check If Non-Negative

Check if the input variable is a non-negative number

Usage

check_if_non_negative(
  x,
  allow_na = TRUE,
  arg = rlang::caller_arg(x),
  error_call = rlang::caller_env()
)

Arguments

x

Input variable to check if it is non-negative number

allow_na

Input boolean to determine if NA or NaN is allowed. Default: TRUE

arg

An argument name as a string. This argument will be mentioned in error messages as the input that is at the origin of a problem.

error_call

The execution environment of a currently running function, e.g. caller_env(). The function will be mentioned in error messages as the source of the error. See the call argument of abort() for more information.

Value

The variable itself or an error message if variable is not non-negative

See also

caller_arg, stack cli_abort

Examples

# No error
input = 0
try(check_if_non_negative(input))

# Error as -5 is not a non-neagtive number
input = -5
try(check_if_non_negative(input))
#> Error in eval(expr, envir) : 
#>   `input` must be non-negative, not -5