R/remapMechs.R

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

#' @export
#' @title Remap Mechanisms
#'
#' @description Function which converts mechanism codes, names or shortnames to
#' UIDs. \code{remapMechs} should be supplied a vector of data mechanisms
#' (names, codes or shortnames) along with the other required paramaters.
#' It will return a vector of UIDs.
#'
#' @inheritParams datim_validation_params
#'
#' @return Returns a vector of mechanism UIDs
#' @examples \dontrun{
#' d <- d2Parser("myfile.csv",type="csv")
#' #Add a new column with organisation unit short names.
#' d$mech_names <- remapMechs(d$attributeOptionCombo,
#'                            mode_in="id",
#'                            mode_out="code")
#' }
remapMechs <-
  function(mechs_in,
           organisationUnit,
           mode_in = "code",
           mode_out = "id",
           d2session = dynGet("d2_default_session", inherits = TRUE)) {
    is_valid_mode <-
      (mode_in %in% c("code", "name", "id")) &
      (mode_out %in% c("code", "name", "id"))
    if (is_valid_mode == FALSE)  {
      print("Not a valid mode. Must be one of code,name or id")
      stop()
    }
    mechs <- getMechanismsMap(organisationUnit, d2session = d2session)
    cmd <-
      paste(
        "plyr::mapvalues(mechs_in,mechs$",
        mode_in,
        ",mechs$",
        mode_out,
        ",warn_missing = FALSE)"
      )
    as.character(eval(parse(text = cmd)))
  }