R/chk.R

In poissonconsulting/term: Create, Manipulate and Query Parameter Terms

#' Check Term or Term Record
#'
#' Checks if term using [vld_term()] or [vld_term_rcrd()].
#'
#' @inheritParams params
#' @inheritParams chk::chk_flag
#' @return `NULL`, invisibly. Called for the side effect of throwing an error
#'   if the condition is not met.
#' @export
#' @examples
#' # chk_term
#' x <- term("x[2]", "x[1]")
#' chk_term(x)
#' x <- c("x[2]", "x[1]")
#' try(chk_term(x, validate = "sorted"))
chk_term <- function(x, validate = "complete", x_name = NULL) {
  if (vld_term(x, validate = validate)) {
    return(invisible())
  }
  if (is.null(x_name)) x_name <- deparse_backtick_chk(substitute(x))

  if (!is_term(x)) abort_chk(x_name, " must be a term vector")
  x <- x[!is.na(x)]
  if (!all(valid_term(x))) {
    abort_chk("All elements of term vector ", x_name, " must be valid")
  }
  if (is_inconsistent_terms(x)) abort_chk("All elements of term vector ", x_name, " must be consistent")
  abort_chk("All elements of term vector ", x_name, " must be complete")
}

#' @describeIn chk_term Check Term Record
#' @export
#' @examples
#'
#' # chk_term_rcrd
#' x <- term_rcrd("x[2]", "x[1]")
#' chk_term_rcrd(x)
#' x <- c("x[2]", "x[1]")
#' try(chk_term_rcrd(x, validate = "sorted"))
chk_term_rcrd <- function(x, validate = "complete", x_name = NULL) {
  if (vld_term_rcrd(x, validate = validate)) {
    return(invisible())
  }
  if (is.null(x_name)) x_name <- deparse_backtick_chk(substitute(x))

  if (!is_term_rcrd(x)) abort_chk(x_name, " must be a term_rcrd vector")
  x <- x[!is.na(x)]
  if (!all(valid_term(x))) {
    abort_chk("All elements of term_rcrd vector ", x_name, " must be valid")
  }
  if (is_inconsistent_terms(x)) abort_chk("All elements of term_rcrd vector ", x_name, " must be consistent")
  abort_chk("All elements of term_rcrd vector ", x_name, " must be complete")
}