R/enum.R

In byapparov/rdqa: Data Quality Logging Pagckage

#' @include rules.R
setClass("EnumRule", contains = "FieldRule", representation(enum = "character"))

#' Creates new enum rule
#'
#' @export
#' @param field name of the field to be validated
#' @param enum vector of allowed character values
#' @return new enum rule
newEnumRule <- function(field, enum) {
  rule <- new(
    "EnumRule",
    name = paste0("Field [", field, "] should should be one of enum values"),
    type = "Enum",
    field = field,
    enum = enum
  )
  return(rule)
}

#' @rdname validate
#' @return for `EnumRule` records where values don't match given list of valid values.
setMethod("validate", signature("EnumRule", "data.table"), function(rule, dt) {
  callNextMethod()
  errors <- subset(
    dt, !is.na(get(rule@field)) & !(get(rule@field) %in% rule@enum)
  )
  return(errors)
})