chk_unique: Check Unique

View source: R/chk-unique.R

chk_uniqueR Documentation

Check Unique

Description

Checks if unique using

!anyDuplicated(x, incomparables = incomparables)

Usage

chk_unique(x, incomparables = FALSE, x_name = NULL)

vld_unique(x, incomparables = FALSE)

Arguments

x

The object to check.

incomparables

A vector of values that cannot be compared. FALSE means that all values can be compared.

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_unique(): Validate Unique

See Also

anyDuplicated()

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

Other misc_checkers: chk_join(), chk_not_any_na(), chk_not_empty()

Examples

# chk_unique
chk_unique(c(NA, 2))
try(chk_unique(c(NA, NA, 2)))
chk_unique(c(NA, NA, 2), incomparables = NA)
# vld_unique
vld_unique(NULL)
vld_unique(numeric(0))
vld_unique(c(NA, 2))
vld_unique(c(NA, NA, 2))
vld_unique(c(NA, NA, 2), incomparables = NA)

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