chk_complex_number {chk} | R Documentation |
Check Complex Number
Description
Checks if non-missing complex scalar using
is.complex(x) && length(x) == 1L && !anyNA(x)
Usage
chk_complex_number(x, x_name = NULL)
vld_complex_number(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_number()
: Validate Complex Number
See Also
For more details about the use of this function, please read the article chk families.
Other scalar_checker:
chk_whole_number()
Examples
# chk_complex_number
chk_complex_number(as.complex(1.1))
try(chk_complex_number(1.1))
# vld_complex_number
vld_complex_number(as.complex(2))
[Package chk version 0.10.0 Index]