Check if a value is an integer scalar

check_scalar_integer() checks whether the input is an integer scalar. If the input is not an integer scalar, it raises an error message. check_is_scalar_integer() returns TRUE if the input is an integer scalar, and FALSE otherwise.

Usage

check_scalar_integer(num, par_name = "num")

check_is_scalar_integer(num)

Arguments

num

A value to check if it is an integer scalar.

par_name

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

Value

• check_scalar_integer(): Returns the original value entered or raises an error message if the value is not an integer scalar.

• check_is_scalar_integer(): Logical value, TRUE if the value is an integer scalar, and FALSE otherwise.

Examples

# Examples for check_scalar_integer()
# -----------------------------------
check_scalar_integer(5L)
#> [1] 5
try(check_scalar_integer(5.1))
#> Error in check_scalar_integer(5.1) : 
#>   Expected 'num' to be an integer but got numeric
check_scalar_integer(10L)
#> [1] 10
try(check_scalar_integer("5"))
#> Error in check_scalar_integer("5") : 
#>   Expected 'num' to be an integer but got character
check_scalar_integer(0L)
#> [1] 0

# Examples for check_is_scalar_integer()
# --------------------------------------
check_is_scalar_integer(5L)
#> [1] TRUE
check_is_scalar_integer(5.1)
#> [1] FALSE
check_is_scalar_integer(10L)
#> [1] TRUE
check_is_scalar_integer("5")
#> [1] FALSE
check_is_scalar_integer(0L)
#> [1] TRUE