Skip to contents

check_even() validates whether the provided number is even, raising an error if it is not. check_is_even() determines whether a number is even and returns a logical value.

Usage

check_even(num, par_name = "num")

check_is_even(num)

Arguments

num

A numeric value to check for evenness.

par_name

An optional name of the parameter to include in error messages.

Value

  • check_even(): Returns the original number if it is even or raises an error otherwise.

  • check_is_even(): Logical value, TRUE if the number is even, and FALSE otherwise.

Examples

# Examples for check_even()
# -------------------------

check_even(2)
#> [1] 2

check_even(0)
#> [1] 0

try(check_even(3))
#> Error in check_even(3) : Expected 'num' to be an even number but got 3

try(check_even(-1))
#> Error in check_even(-1) : Expected 'num' to be an even number but got -1

check_even(-4)
#> [1] -4

# Examples for check_is_even()
# ----------------------------

check_is_even(2)
#> [1] TRUE

check_is_even(3)
#> [1] FALSE

check_is_even(0)
#> [1] TRUE

check_is_even(-1)
#> [1] FALSE

check_is_even(-4)
#> [1] TRUE