R/read_ONS_census2011.R

In ETHPOP-and-ETS/demoSynthPop: Creates a synthetic cohort using demographic data.

#' read_ONS_census2011
#'
#' @param dir_name
#' @param file_name
#' @param save_dir
#' @param save_filename
#'
#' @import readxl, dplyr, tidyr, tibble, stringr
#' @return
#' @export
#'
read_ONS_census2011 <- function(dir_name = here::here("raw data"),
                                file_name = "CT0596_2011 Census - Sex by age by COB by ethnic group by YOA- Merged LA.xlsx",
                                save_dir = here::here("output_data"),
                                save_filename = "ONS_census2011") {

  file_loc <- paste(dir_name, file_name, sep = "/")

  dat <-
    readxl::read_xlsx(file_loc, range = "A10:AJC15", sheet = "All usual residents", col_names = FALSE) %>%
    t() %>%
    as_tibble()

  dat <-
    dat %>%
    fill(V1, .direction = "down") %>%
    fill(V2, .direction = "down") %>%
    fill(V3, .direction = "down") %>%
    `names<-`(c("sex", "agegrp", "cob", "ethgrp", "pop_EW", "pop_E")) %>%
    na.omit() %>%
    mutate(agegrp = gsub(agegrp, pattern = "Age", replacement = ""),
           sex = ifelse(sex == "Males", "M", ifelse(sex == "Females", "F", "persons")))


  ## mapping ethnic groups to ETHPOP
  # BAN (Asian/Asian British: Bangladeshi),
  # BLA (Black/African/Caribbean/Black British),
  # BLC (Black/African/Caribbean/Black British),
  # CHI (Asian/Asian British: Chinese),
  # IND (Asian/Asian British: Indian),
  # MIX (Mixed/multiple ethnic groups: White and Black Caribbean/ White and Black African/White and Asian/Other Mixed, Asian/Asian British: Other Asian, Other ethnic group: Arab, Other ethnic group: Any other ethnic group),
  # OAS (Mixed/multiple ethnic groups: White and Black Caribbean/ White and Black African/White and Asian/Other Mixed, Asian/Asian British: Other Asian, Other ethnic group: Arab, Other ethnic group: Any other ethnic group),
  # OBL (Other Black),
  # OTH (Mixed/multiple ethnic groups: White and Black Caribbean/ White and Black African/White and Asian/Other Mixed, Asian/Asian British: Other Asian, Other ethnic group: Arab, Other ethnic group: Any other ethnic group),
  # PAK (Asian/Asian British: Pakistani),
  # WBI (White: English/Welsh/Scottish/Northern Irish/British/Irish/Gypsy or Irish Traveller/Other White),
  # WHO (White: English/Welsh/Scottish/Northern Irish/British/Irish/Gypsy or Irish Traveller/Other White)

  if (!is.na(save_filename)) {

    saveRDS(dat, file = paste0(save_dir, "/", save_filename, ".Rds", sep = ""))
    write.csv(dat, file = paste0(save_dir, "/", save_filename, ".csv", sep = ""))
  }

  return(dat)
}