chk_orderset: Check Set Ordered

In chk: Check User-Supplied Function Arguments

Check Set Ordered

Description

Checks if the first occurrence of each shared element in x is equivalent to the first occurrence of each shared element in values using vld_equivalent(unique(x[x %in% values]), values[values %in% x]).

Usage

chk_orderset(x, values, x_name = NULL)

vld_orderset(x, values)

Arguments

x	The object to check.
values	A vector of the permitted values.
x_name	A string of the name of object x or NULL.

Value

The chk_ function throws an informative error if the test fails.

The vld_ function returns a flag indicating whether the test was met.

Functions

• vld_orderset(): Validate Set Ordered

See Also

vld_equivalent()

unique()

For more details about the use of this function, please read the article vignette("chk-families").

Other set_checkers: chk_not_subset(), chk_setequal(), chk_subset(), chk_superset()

Examples

# chk_orderset
chk_orderset(1:2, 1:2)
try(chk_orderset(2:1, 1:2))

# vld_orderset
vld_orderset(1, 1)
vld_orderset(1:2, 2:1)
vld_orderset(1, 2:1)
vld_orderset(1:2, 2)

chk documentation built on Sept. 3, 2026, 9:07 a.m.