chk_complex: Check Complex

In chk: Check User-Supplied Function Arguments

Check Complex

Description

Checks if complex using

is.complex(x)

Usage

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

is.complex()

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))
# vld_complex
vld_complex(1i)
vld_complex(complex())
vld_complex(NA_complex_)
vld_complex(1)
vld_complex(TRUE)

chk documentation built on April 3, 2025, 8:50 p.m.