Check Numeric — chk_numeric • chk

Checks if numeric using

is.numeric(x)

Pass: 1, 1:2, NA_real_, integer(0), matrix(1:3).

Fail: TRUE, "1", NA, NULL.

Usage

chk_numeric(x, x_name = NULL)

vld_numeric(x)

Arguments

x: The object to check.
x_name: A string of the name of object x or NULL.

Value

The chk_ function throws an informative error if the test fails or returns the original object if successful so it can used in pipes.

The vld_ function returns a flag indicating whether the test was met.

Functions

vld_numeric(): Validate Numeric

See also

Other chk_is: chk_array(), chk_atomic(), chk_data(), chk_function(), chk_is(), chk_matrix(), chk_s3_class(), chk_s4_class(), chk_vector(), chk_whole_numeric()

Examples

# chk_numeric
chk_numeric(1)
try(chk_numeric("1"))
#> Error in eval(expr, envir) : `"1"` must be numeric.
# vld_numeric
vld_numeric(1)
#> [1] TRUE
vld_numeric(1:2)
#> [1] TRUE
vld_numeric(NA_real_)
#> [1] TRUE
vld_numeric(integer(0))
#> [1] TRUE
vld_numeric("1")
#> [1] FALSE
vld_numeric(TRUE)
#> [1] FALSE