Skip to contents

Check Subset

Source: R/chk-not-subset.R, R/chk-subset.R
chk_subset.Rd

Checks if all values in values using

all(x %in% values)

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

Other chk_set: chk_join(), chk_not_subset(), chk_orderset(), chk_superset(), vld_orderset()

Examples

# vld_not_subset
vld_not_subset(numeric(0), 1:10)
#> [1] TRUE
vld_not_subset(1, 1:10)
#> [1] FALSE
vld_not_subset(11, 1:10)
#> [1] TRUE
# chk_subset
chk_subset(1, 1:10)
try(chk_subset(11, 1:10))
#> Error in eval(expr, envir, enclos) : 
#>   `11` must match 1, 2, 3, 4, 5, 6, 7, 8, 9 or 10, not 11.
# vld_subset
vld_subset(numeric(0), 1:10)
#> [1] TRUE
vld_subset(1, 1:10)
#> [1] TRUE
vld_subset(11, 1:10)
#> [1] FALSE