chk_scalar {chk} | R Documentation |
Check Scalar
Description
Checks if is a vector using
length(x) == 1L
Usage
chk_scalar(x, x_name = NULL)
vld_scalar(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_scalar()
: Validate Scalar
See Also
Other chk_scalars:
chk_date()
,
chk_date_time()
,
chk_number()
,
chk_string()
,
chk_tz()
,
chk_whole_number()
Examples
# chk_scalar
chk_scalar(1)
chk_scalar(list(1))
try(chk_scalar(1:2))
# vld_scalar
vld_scalar(1)
[Package chk version 0.9.2 Index]