R/checkDataElementDisaggValidity.R

In jason-p-pickering/datim-validation: External Validation Routines for Data Payloads in DATIM

#' @export
#' @title Check Data Element Disagg Validity
#'
#' @description Utility function to produce a data frame of
#' invalid data elements based on current
#' DATIM form specification.
#'
#' @inheritParams datim_validation_params
#'
#' @return Returns a data frame  of "dataElementName","categoryOptionComboName",
#' "dataElement","categoryOptionCombo"
#' of invalid data elements which are present the the data, if any.
#' If there are no violations, a boolean TRUE is returned.
#' @examples \dontrun{
#'   d <- d2Parser("myfile.csv",type="csv")
#'   ds <- getCurrentDataSets(type="RESULTS")
#'   checkDataElementDisaggValidity(d,ds)
#' }
checkDataElementDisaggValidity <- function(d,
                                           datasets = NA,
                                           d2session =
                                             dynGet("d2_default_session",
                                                    inherits = TRUE)) {

  des <- getValidDataElements(datasets, d2session = d2session) %>%
         dplyr::select(dataElement = dataelementuid,
                       categoryOptionCombo = categoryoptioncombouid)

  data_des_cocs_bad <- dplyr::anti_join(d$data$import,
                                        des,
                                        by = c("dataElement",
                                               "categoryOptionCombo"))

  if (NROW(data_des_cocs_bad) > 0) {
     msg <- "ERROR! Invalid data element / category option combos found!"
     d$info$messages <- appendMessage(d$info$messages, msg, "ERROR")
     d$tests$data_des_cocs_bad <- data_des_cocs_bad

  } else {
    msg <- "No invalid data element/ category option combos detected"
    d$info$messages <- appendMessage(d$info$messages, msg, "INFO")
  }

  d

}