chk_subset: Check Subset

In chk: Check User-Supplied Function Arguments

Check Subset

Description

Checks if all values in values using

all(x %in% values)

Pay attention to the order of the arguments value and x in this function compared to chk_superset()

Usage

vld_not_subset(x, values)

chk_subset(x, values, x_name = NULL)

vld_subset(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 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_not_subset(): Validate Not Subset

• vld_subset(): Validate Subset

See Also

all()

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

Other set_checkers: chk_not_subset(), chk_orderset(), chk_superset(), vld_orderset()

Examples

# vld_not_subset
vld_not_subset(numeric(0), 1:10)
vld_not_subset(1, 1:10)
vld_not_subset(11, 1:10)
# chk_subset
chk_subset(1, 1:10)
try(chk_subset(11, 1:10))
# vld_subset
vld_subset(numeric(0), 1:10)
vld_subset(1, 1:10)
vld_subset(11, 1:10)

chk documentation built on April 3, 2025, 8:50 p.m.