R/gen_admin_div.R

In healthinnovation/lis: InnovaLab Toolkit

#' Create categories for adiministrative divisions (Peru)
#'
#' @description Function 'gen_admin_div' returns the natural, geographical, or
#'   administrative division of Peru that includes the region, province or district
#'   provided to the function.
#'
#' @param x x is a list/vector with one of the 25 regions/departments names of
#'   Peru (first-level administrative subdivisions).
#' @param method defines the type of natural, geographical, or administrative
#'   division that should be returned. Possible values are:
#'
#'   - Traditional: Coastal, Andes Mountains, Amazon Jungle, or Lima & Callao
#'   - TC: (Lima no incluye Huarua/Cañete)\href{https://andina.pe/agencia/noticia-tc-crea-cinco-macro-regiones-para-facilitar-acceso-a-justicia-constitucional-604658.aspx}{Administratives Macro Regions of the Constitutional Tribunal}
#'   - Cardinal: North, South, Amazon Jungle, or Lima & Callao
#'   - Trad_Cardinal:  Coastal and Andes Mountains are divided into North and South (e.g. South Andes Mountains)
#'
#' @return Converts characters where it detects regions of Peru with the resulting divisions specified.
#' @importFrom dplyr mutate
#' @examples
#' library(innovar)
#' library(dplyr)
#' df_dep <- data.frame(
#' Region = c("LIMA", "CALLAO", "CAJAMARCA", "AMAZONAS",
#'            "SAN MARTIN", "HUANUCO", "PASCO", "JUNIN", "CUSCO", "PUNO", "APURIMAC",
#'             "AYACUCHO", "HUANCAVELICA", "TUMBES", "PIURA", "LAMBAYEQUE",
#'             "LA LIBERTAD", "ANCASH", "ICA", "AREQUIPA", "TACNA", "MOQUEGUA",
#'             "LORETO", "UCAYALI", "MADRE DE DIOS"), stringsAsFactors = FALSE
#'           )
#'
#' df_dep %>%
#'   mutate(
#'     Reg_traditional = gen_admin_div(Region, method = "Traditional"),
#'     Reg_TC = gen_admin_div(Region, method = "TC"),
#'     Reg_Cardinal = gen_admin_div(Region, method = "Cardinal"),
#'     Reg_Trad_Cardinal = gen_admin_div(Region, method = "Trad_Cardinal")
#'   )
#'
#' @export gen_admin_div
#'
gen_admin_div <- function(x,
                          method="Traditional") {
  reg_mountain_north <- c("CAJAMARCA","AMAZONAS","SAN MARTIN","HUANUCO","PASCO")
  reg_mountain_south <- c("JUNIN","CUSCO","PUNO","APURIMAC","AYACUCHO","HUANCAVELICA")
  reg_coastal_north <- c("TUMBES","PIURA","LAMBAYEQUE","LA LIBERTAD","ANCASH")
  reg_coastal_south <- c("ICA","AREQUIPA","TACNA","MOQUEGUA")

  reg_south <- c("JUNIN","HUANCAVELICA","ICA","AYACUCHO","APURIMAC",
                 "AREQUIPA","MOQUEGUA","TACNA","PUNO","CUSCO")
  reg_north <- c("TUMBES","PIURA","LAMBAYEQUE","LA LIBERTAD","ANCASH",
                 "CAJAMARCA","AMAZONAS","SAN MARTIN","HUANUCO","PASCO")
  reg_jungle <- c("LORETO","UCAYALI","MADRE DE DIOS")

  reg_tc_north <- c("ANCASH","CAJAMARCA","LA LIBERTAD",
                    "LAMBAYEQUE","PIURA","TUMBES")
  reg_tc_center <- c("APURIMAC","AYACUCHO","HUANCAVELICA",
                     "HUANUCO","JUNIN","PASCO","ICA")
  reg_tc_south <- c("AREQUIPA","CUSCO","MADRE DE DIOS",
                    "MOQUEGUA","PUNO","TACNA")
  reg_tc_east <- c("AMAZONAS","LORETO","SAN MARTIN","UCAYALI")

  x <- allpautils_names(x)
  x <- toupper(x)

  if(method =="Traditional") {

    x <- replace(x, x %in% reg_jungle, "AMAZON JUNGLE")
    x <- replace(x, x %in% reg_mountain_north | x %in% reg_mountain_south, "ANDES MOUNTAINS")
    x <- replace(x, x %in% reg_coastal_north | x %in% reg_coastal_south, "COASTAL")
    x <- replace(x, x == "CALLAO" | x == "LIMA", "LIMA & CALLAO")

  } else if(method == "TC") {

    x <- replace(x, x %in% reg_tc_north, "NORTH")
    x <- replace(x, x %in% reg_tc_south, "SOUTH")
    x <- replace(x, x %in% reg_tc_center, "CENTER")
    x <- replace(x, x %in% reg_tc_east, "EAST")
    x <- replace(x, x == "CALLAO" | x == "LIMA", "LIMA & CALLAO")
    # Deberian ser solo los distritos de Lima, Callao, más Huarua/Cañete. Por ahora todo LIMA will do just fine
  } else if(method == "Cardinal") {

    x <- replace(x, x %in% reg_north,"NORTH")
    x <- replace(x, x %in% reg_south ,"SOUTH")
    x <- replace(x, x %in% reg_jungle,"AMAZON JUNGLE")
    x <- replace(x, x =="CALLAO" | x =="LIMA","LIMA & CALLAO")

  } else if(method == "Trad_Cardinal") {

    x <- replace(x, x %in% reg_jungle, "AMAZON JUNGLE")
    x <- replace(x, x %in% reg_mountain_south, "SOUTH ANDES MOUNTAINS")
    x <- replace(x, x %in% reg_mountain_north, "NORTH ANDES MOUNTAINS")
    x <- replace(x, x %in% reg_coastal_north, "NORTH COAST")
    x <- replace(x, x %in% reg_coastal_south, "SOUTH COAST")
    x <- replace(x, x == "CALLAO" | x == "LIMA", "LIMA & CALLAO")
  }
  return(x)
}