Check if a value is a numeric scalar

check_scalar_numeric() checks whether the input is a numeric scalar. If the input is not a numeric scalar, it raises an error message. check_is_scalar_numeric() returns TRUE if the input is a numeric scalar, and FALSE otherwise.

Usage

check_scalar_numeric(num, par_name = "num")

check_is_scalar_numeric(num)

Arguments

num

A value to check if it is a numeric scalar.

par_name

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

Value

• check_scalar_numeric(): Returns the original value entered or raises an error message if the value is not a numeric scalar.

• check_is_scalar_numeric(): Logical value, TRUE if the value is a numeric scalar, and FALSE otherwise.

Examples

# Examples for check_scalar_numeric()
# -----------------------------------
check_scalar_numeric(10)
#> [1] 10
try(check_scalar_numeric(c(1, 2, 3)))
#> Error in check_scalar_numeric(c(1, 2, 3)) : 
#>   Expected 'num' to be a numeric scalar but got 1, 2, 3
check_scalar_numeric(5.5)
#> [1] 5.5
try(check_scalar_numeric("text"))
#> Error in check_scalar_numeric("text") : 
#>   Expected 'num' to be a numeric scalar but got 'text'
check_scalar_numeric(0)
#> [1] 0

# Examples for check_is_scalar_numeric()
# --------------------------------------
check_is_scalar_numeric(10)
#> [1] TRUE
check_is_scalar_numeric(c(1, 2, 3))
#> [1] FALSE
check_is_scalar_numeric(5.5)
#> [1] TRUE
check_is_scalar_numeric("text")
#> [1] FALSE
check_is_scalar_numeric(0)
#> [1] TRUE