check_sorted: Check Sorted

In poissonconsulting/checkr: Check the Properties of Common R Objects

Check Sorted

Description

Checks whether object x is sorted using !is.unsorted(x, na.rm = TRUE).

Usage

check_sorted(x, x_name = substitute(x), error = TRUE)

Arguments

x	The object to check.
x_name	A string of the name of the object x.
error	A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.

Value

An invisible copy of x (if it doesn't throw an error).

See Also

check_vector and check_list

Examples

check_sorted(1:2, error = FALSE)
check_sorted(2:1, error = FALSE)

poissonconsulting/checkr documentation built on Oct. 18, 2023, 9:39 p.m.