chk_sorted {chk} | R Documentation |
Check Sorted
Description
Checks if is sorted using
is.unsorted(x, na.rm = TRUE)
Usage
chk_sorted(x, x_name = NULL)
vld_sorted(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_sorted()
: Validate Sorted
See Also
For more details about the use of this function,
please read the article
vignette("chk-families")
.
Examples
# chk_sorted
chk_sorted(1:2)
try(chk_sorted(2:1))
# vld_sorted
vld_sorted(1:2)
vld_sorted(2:1)
[Package chk version 0.10.0 Index]