BYOC_ID: 46026 - Refactor hhg

NAMESPACE

@@ -54,6 +54,7 @@ export(get_gpprac_opendata)
 export(get_gpprac_ref_path)
 export(get_hc_costs_path)
 export(get_hc_raw_costs_path)
+export(get_hhg_data)
 export(get_hhg_path)
 export(get_homelessness_completeness_path)
 export(get_it_deaths_path)

R/create_episode_file.R

@@ -7,6 +7,7 @@
 #' @param write_to_disk (optional) Should the data be written to disk default is
 #' `TRUE` i.e. write the data to disk.
 #' @param write_temp_to_disk write intermediate data for investigation or debug
+#' @param BYOC_MODE BYOC mode
 #' @inheritParams add_nsu_cohort
 #' @inheritParams fill_geographies
 #' @inheritParams join_cohort_lookups
@@ -30,20 +31,21 @@
   ),
   sc_client = read_file(get_sc_client_lookup_path(year)),
   write_to_disk = TRUE,
-  write_temp_to_disk = FALSE
+  write_temp_to_disk = FALSE,
+  BYOC_MODE
 ) {
   log_ep_substage("Create episode file", "started", year)
 
   processed_data_list <- purrr::discard(processed_data_list, ~ is.null(.x) | identical(.x, tibble::tibble()))
 
   episode_file <- dplyr::bind_rows(processed_data_list) %>%
     write_temp_data(year, file_name = "ep_temp1", write_temp_to_disk) %>%
     add_homelessness_flag(year, lookup = homelessness_lookup) %>%
     add_homelessness_date_flags(year, lookup = homelessness_lookup) %>%
     link_delayed_discharge_eps(year, dd_data) %>%
     write_temp_data(year, file_name = "ep_temp1-2", write_temp_to_disk) %>%
     add_nsu_cohort(year, nsu_cohort) %>%
     create_cost_inc_dna() %>%
     apply_cost_uplift()
 
   if (!check_year_valid(year, type = c("ch", "hc", "at", "sds"))) {
@@ -160,7 +162,7 @@
     write_temp_data(year, file_name = "ep_temp4", write_temp_to_disk) %>%
     create_cohort_lookups(year) %>%
     join_cohort_lookups(year) %>%
-    join_sparra_hhg(year) %>%
+    join_sparra_hhg(year, BYOC_MODE = BYOC_MODE) %>%
     fill_geographies(
       slf_pc_lookup,
       slf_gpprac_lookup

R/create_individual_file.R

@@ -5,6 +5,7 @@
 #' @param episode_file Tibble containing episodic data.
 #' @param homelessness_lookup the lookup file for homelessness
 #' @param write_temp_to_disk write intermediate data for investigation or debug
+#' @param BYOC_MODE BYOC mode
 #' @inheritParams create_episode_file
 #'
 #' @return The processed individual file
@@ -15,7 +16,8 @@ create_individual_file <- function(
   year,
   homelessness_lookup = create_homelessness_lookup(year),
   write_to_disk = TRUE,
-  write_temp_to_disk
+  write_temp_to_disk,
+  BYOC_MODE
 ) {
   log_ind_substage("Create individual file", "started", year)
 
@@ -89,7 +91,7 @@ create_individual_file <- function(
     add_homelessness_flag(year, lookup = homelessness_lookup) %>%
     match_on_ltcs(year) %>%
     join_deaths_data(year) %>%
-    join_sparra_hhg(year) %>%
+    join_sparra_hhg(year, BYOC_MODE = BYOC_MODE) %>%
     write_temp_data(year, file_name = "indiv_temp4", write_temp_to_disk) %>%
     join_slf_lookup_vars() %>%
     dplyr::mutate(year = year) %>%

R/get_sparra_hhg_paths.R

@@ -23,6 +23,41 @@ get_hhg_path <- function(year, ...) {
   return(hhg_file_path)
 }
 
+
+#' HHG Extract File data
+#'
+#' @description Get the path to the HHG extract
+#'
+#' @param year Year of extract
+#' @param denodo_connect connection to denodo
+#' @param BYOC_MODE BYOC MODE
+#'
+#' @return The path to the HHG extract as an [fs::path()]
+#' @export
+#' @family extract file paths
+#' @seealso [get_file_path()] for the generic function.
+get_hhg_data <- function(year,
+                         denodo_connect = get_denodo_connection(BYOC_MODE = BYOC_MODE),
+                         BYOC_MODE) {
+  year <- check_year_format(year, format = "fyyear")
+  c_year <- convert_fyyear_to_year(year)
+
+  on.exit(try(DBI::dbDisconnect(denodo_connect), silent = TRUE), add = TRUE)
+
+  if (isTRUE(BYOC_MODE)) {
+    extract_hhg <- dplyr::tbl(
+      denodo_connect,
+      dbplyr::in_schema("sdl", "sdl_hhg_source") ### TODO: confirm table name ###
+    ) %>%
+      dplyr::filter(risk_financial_year == c_year) %>% ### TODO: confirm filter ###
+      dplyr::collect()
+  } else {
+    extract_hhg <- read_file(get_hhg_path(year))
+  }
+  return(extract_hhg)
+}
+
+
 #' SPARRA Extract File Path
 #'
 #' @description Get the path to the SPARRA extract

R/join_sparra_hhg.R

@@ -4,7 +4,9 @@
 #'
 #' @return The data including the SPARRA and HHG variables matched
 #' on to the episode file.
-join_sparra_hhg <- function(data, year) {
+join_sparra_hhg <- function(data,
+                            year,
+                            BYOC_MODE = BYOC_MODE) {
   if (check_year_valid(year, "sparra")) {
     data <- dplyr::left_join(
       data,
@@ -34,7 +36,7 @@ join_sparra_hhg <- function(data, year) {
   if (check_year_valid(year, "hhg")) {
     data <- dplyr::left_join(
       data,
-      read_file(get_hhg_path(year)) %>%
+      get_hhg_data(year, BYOC_MODE = BYOC_MODE) %>%
         dplyr::rename(hhg_start_fy = "hhg_score"),
       by = c("anon_chi"),
       na_matches = "never",
@@ -47,7 +49,7 @@ join_sparra_hhg <- function(data, year) {
   if (check_year_valid(next_fy(year), "hhg")) {
     data <- dplyr::left_join(
       data,
-      read_file(get_hhg_path(next_fy(year))) %>%
+      get_hhg_data(next_fy(year), BYOC_MODE = BYOC_MODE) %>%
         dplyr::rename(hhg_end_fy = "hhg_score"),
       by = c("anon_chi"),
       na_matches = "never",