pretestcad (version 1.1.0)

check_if_positive: Check If Positive

Description

Check if the input variable is a positive number

Usage

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

Value

The variable itself or an error message if variable is not positive

Arguments

x

Input variable to check if it is positive 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.

See Also

caller_arg, stack cli_abort

Examples

# No error
input = 1
try(check_if_positive(input))

# Error as 0 is not a positive number
input = 0
try(check_if_positive(input))

# Error as -5 is not a positive number
input = -5
try(check_if_positive(input))