R/clean_outmigrants.R

In ETHPOP-and-ETS/cleanETHPOP: Clean ETHPOP Data For Use in a TB DES Model

#' clean_outmigrants
#'
#' @param dir_path
#' @param rtn
#' @param save_to_file
#' @param save_name
#' @param save_folder
#' @param save_format
#' @param age_grp
#'
#' @return
#' @export
#' @import dplyr
#' @importFrom readr read_csv
#' @examples
#'   clean_outmigrants()
#'
clean_outmigrants <- function(
  dir_path = system.file("extdata", "Leeds1", "OutMigrants", package = "cleanETHPOP"),
  rtn = TRUE,
  age_grp = FALSE,
  save_to_file = TRUE,
  save_name = "clean_outmigrants",
  save_folder = here::here("output_data"),
  save_format = "csv") {

  file_names <- list.files(dir_path)

  outmigrants_year <- list()

  for (i in seq_along(file_names)) {

    dat <- read_csv(paste(dir_path, file_names[i], sep = "/"))
    year_name <- unlist(strsplit(file_names[i], "_"))[2]

    outmigrants_year[[i]] <-
      dat %>%
      select(-MB.0, -FB.0) %>%
      filter(grepl('E', LAD.code)) %>%
      group_by(ETH.group) %>%
      summarise_at(.vars = vars(M0.1:F100.101p),
                   sum) %>%
      melt(id.vars = "ETH.group") %>%

      # clean age variable
      separate(variable, c("age", NA)) %>%
      separate(age, c("sex", "age"), sep = 1) %>%
      mutate(age = gsub("p", "", age)) %>%
      group_by(age)

    if (age_grp) { # group ages in to 5 year ranges
      outmigrants_year[[i]] <-
        outmigrants_year[[i]] %>%
        ungroup(age) %>%
        mutate(agegrp = cut(as.numeric(age),
                            breaks = seq(0, 105, by = 5),
                            right = FALSE)) %>%
        group_by(agegrp)
    }

    outmigrants_year[[i]] <-
      outmigrants_year[[i]] %>%
      group_by(ETH.group,
               sex,
               add = TRUE) %>%
      summarise(outmigrants = sum(value)) %>%
      mutate(year = year_name) %>%
      ungroup()
  }

  outmigrants_dat <- do.call(rbind, outmigrants_year)

  if (save_to_file) {

    save_fn <-
      if(save_format == "csv") {write.csv}
    else if(save_format == "RData") {save}

    save_path <- paste0(save_folder, "/", save_name, ".", save_format)
    write.csv(outmigrants_dat, file = save_path)
  }

  if (rtn)
    return(outmigrants_dat)
}