R/remapOUs.R

In gandiwan/datim-validation: External validation routines for data payloads in DATIM

#' @export
#' @title Function which converts mechanism codes, names or shortnames to to another class of identifiers
#'
#' @description remapOUs should be supplied a vector of organisation Units (names,codes or shortnames)
#' along with the other required paramaters. It will return a vector of to another class of identifiers.
#'
#' @param ous_in A vector of organisation unit identifiers (codes, names or shortNames)
#' @param organisationUnit UID of the Operating Unit/Country
#' @param mode_in Should be one of code, name, shortName or id. This is the class we are mapping from.
#' @param mode_out Should be on of code,name,shortName or id. This is the class we are mapping to.
#' @return Returns a vector of organisation unit UIDs
#' @note
#' remapOUs(foo,"https://www.datim.org","admin","district","code","id","Ab12345678")
#' will remap organisation units specified as codes to UIDs
remapOUs <-
  function(ous_in,
           organisationUnit,
           mode_in = "code",
           mode_out = "id") {
    is_valid_mode <-
      (mode_in %in% c("code", "name", "shortName", "id"))  &
      (mode_out %in% c("code", "name", "shortName", "id"))
    if (is_valid_mode == FALSE)  {
      print("Not a valid mode. Must be one of code,name,shortName or id")
      stop()
    } else {
      sites <-
        getOrganisationUnitMap(organisationUnit)
      cmd <-
        paste0(
          "plyr::mapvalues(ous_in,sites$",
          mode_in,
          ",sites$",
          mode_out,
          ",warn_missing = FALSE)"
        )
      as.character(eval(parse(text = cmd)))
    }
  }