R/chk-subset.R

In poissonconsulting/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()]
#'
#'
#' @inheritParams params
#' @inherit params return
#'
#' @family set_checkers
#'
#' @seealso [all()]
#' @seealso For more details about the use of this function,
#' please read the article
#' `vignette("chk-families")`.
#'
#' @examples
#' # chk_subset
#' chk_subset(1, 1:10)
#' try(chk_subset(11, 1:10))
#' @export
chk_subset <- function(x, values, x_name = NULL) {
  if (vld_subset(x, values)) {
    return(invisible(x))
  }
  values <- sort(unique(values), na.last = TRUE)
  if (is.null(x_name)) x_name <- deparse_backtick_chk(substitute(x))
  if (length(x) == 1L) {
    abort_chk(x_name, " must match ", cc(values, " or "), ", not ", cc(x), x = x, values = values)
  }
  abort_chk(x_name, " must have values matching ", cc(values, " or "), x = x, values = values)
}

#' @describeIn chk_subset Validate Subset
#'
#' @examples
#' # vld_subset
#' vld_subset(numeric(0), 1:10)
#' vld_subset(1, 1:10)
#' vld_subset(11, 1:10)
#' @export
vld_subset <- function(x, values) all(x %in% values)