711 pop estimate eg datazone (#859)

* change get_datazone_pop_path to get_pop_path to allow for more types

* Update documentation

* Style code

---------

Co-authored-by: lizihao-anu <[email protected]>

NAMESPACE

@@ -27,7 +27,6 @@ export(find_latest_file)
 export(fy_interval)
 export(get_boxi_extract_path)
 export(get_ch_costs_path)
-export(get_datazone_pop_path)
 export(get_dd_path)
 export(get_dd_period)
 export(get_demographic_cohorts_path)
@@ -52,6 +51,7 @@ export(get_locality_path)
 export(get_lookups_dir)
 export(get_ltcs_path)
 export(get_nsu_path)
+export(get_pop_path)
 export(get_practice_details_path)
 export(get_readcode_lookup_path)
 export(get_sc_at_episodes_path)

R/get_lookup_paths.R

@@ -94,29 +94,46 @@ get_simd_path <- function(file_name = NULL, ext = "parquet") {
   return(simd_path)
 }
 
-# TODO update this function to look for a specified type of pop estimate e.g. datazone, hscp etc.
-#' Datazone Populations File Path
+
+#' Populations File Path for different types
 #'
-#' @description Get the path to the Datazone populations estimates
+#' @description Get the path to the populations estimates
 #'
 #' @inheritParams get_file_path
 #'
 #' @return An [fs::path()] to the populations estimates file
 #' @export
 #'
 #' @family lookup file paths
-get_datazone_pop_path <- function(file_name = NULL, ext = "rds") {
-  datazone_pop_dir <-
+get_pop_path <- function(file_name = NULL,
+                         ext = "rds",
+                         type = c(
+                           "datazone",
+                           "hscp",
+                           "ca",
+                           "hb",
+                           "intzone"
+                         )) {
+  pop_dir <-
     fs::path(get_lookups_dir(), "Populations", "Estimates")
 
+  file_name_re <- dplyr::case_match(
+    type,
+    "datazone" ~ stringr::str_glue("DataZone2011_pop_est_2011_\\d+?\\.{ext}"),
+    "hscp" ~ stringr::str_glue("HSCP2019_pop_est_1981_\\d+?\\.{ext}"),
+    "ca" ~ stringr::str_glue("CA2019_pop_est_1981_\\d+?\\.{ext}"),
+    "hb" ~ stringr::str_glue("HB2019_pop_est_1981_\\d+?\\.{ext}"),
+    "intzone" ~ stringr::str_glue("IntZone_pop_est_2011_\\d+?\\.{ext}")
+  )
+
   datazone_pop_path <- get_file_path(
-    directory = datazone_pop_dir,
+    directory = pop_dir,
     file_name = file_name,
     ext = ext,
-    file_name_regexp = stringr::str_glue("DataZone2011_pop_est_2001_\\d+?\\.{ext}")
+    file_name_regexp = file_name_re
   )
 
-  return(datazone_pop_path)
+  return(pop_path)
 }