Check Complex — chk_complex • chk

Checks if complex using

is.complex(x)

chk_complex(x, x_name = NULL)

vld_complex(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_complex(): Validate Complex

See also

For more details about the use of this function, please read the article chk families.

Other data_type_checkers: chk_character(), chk_character_or_factor(), chk_double(), chk_environment(), chk_integer(), chk_logical(), chk_numeric(), chk_raw()

Examples

# chk_complex
chk_complex(1i)
try(chk_complex(1))
#> Error in eval(expr, envir) : `1` must be complex.
# vld_complex
vld_complex(1i)
#> [1] TRUE
vld_complex(complex())
#> [1] TRUE
vld_complex(NA_complex_)
#> [1] TRUE
vld_complex(1)
#> [1] FALSE
vld_complex(TRUE)
#> [1] FALSE