R/check-scalar-hasDuplicates.R

In acidgenomics/goalie: Assertive Check Functions

#' Does the input have duplicates?
#'
#' @name check-scalar-hasDuplicates
#' @note Updated 2023-01-12.
#'
#' @inherit check
#' @inheritParams AcidRoxygen::params
#'
#' @seealso
#' - `assertive.properties::has_duplicates()`.
#' - `assertive.properties::has_no_duplicates()`.
#'
#' @examples
#' ## TRUE ====
#' hasDuplicates(c("a", "a"))
#' hasNoDuplicates(c("a", "b"))
#'
#' ## FALSE ====
#' hasDuplicates(c("a", "b"))
#' hasNoDuplicates(c("a", "a", "b", "b"))
NULL



#' @rdname check-scalar-hasDuplicates
#' @export
hasDuplicates <- function(x) {
    ok <- anyDuplicated(x) > 0L
    if (!isTRUE(ok)) {
        return(false("{.var %s} has no duplicates.", .toName(x)))
    }
    TRUE
}



#' @rdname check-scalar-hasDuplicates
#' @export
hasNoDuplicates <- function(x) {
    ok <- anyDuplicated(x) == 0L
    if (!isTRUE(ok)) {
        if (is(x, "Rle")) {
            requireNamespaces("S4Vectors")
            x <- S4Vectors::decode(x)
        }
        dupeIndicies <- which(duplicated(x))
        return(false(
            ngettext(
                n = length(dupeIndicies),
                msg1 = "{.var %s} has a duplicate at position %s.",
                msg2 = "{.var %s} has duplicates at positions %s."
            ),
            .toName(x),
            toString(dupeIndicies, width = 100L)
        ))
    }
    TRUE
}