Rename run_episode_file() -> create_episode_file() (#803)

* Rename `run_episode_file()` -> `create_episode_file()` This improves consistency! When speaking to Megan we noted that having the two 'main' functions with different names was needlessly confusing! * Delete run_targets_tests.R * Update documentation --------- Co-authored-by: Jennit07 <[email protected]> Co-authored-by: Jennit07 <[email protected]> Co-authored-by: Megan McNicol <[email protected]>
Public-Health-Scotland · Sep 25, 2023 · bc2e4b3 · bc2e4b3
1 parent 9652c69
commit bc2e4b3
Show file tree

Hide file tree

Showing 40 changed files with 60 additions and 61 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -13,6 +13,7 @@ export(convert_hscp_to_hscpnames)
 export(convert_numeric_to_date)
 export(convert_sending_location_to_lca)
 export(convert_year_to_fyyear)
+export(create_episode_file)
 export(create_individual_file)
 export(create_service_use_cohorts)
 export(end_fy)
@@ -155,7 +156,6 @@ export(read_sc_all_alarms_telecare)
 export(read_sc_all_care_home)
 export(read_sc_all_home_care)
 export(read_sc_all_sds)
-export(run_episode_file)
 export(setup_keyring)
 export(start_fy)
 export(start_fy_quarter)

diff --git a/R/run_episode_file.R → R/create_episode_file.R b/R/run_episode_file.R → R/create_episode_file.R
@@ -1,16 +1,15 @@
-#' Produce the Source Episode file
+#' Create the Source Episode file
 #'
 #' @param processed_data_list containing data from processed extracts.
 #' @param year The year to process, in FY format.
 #' @param write_to_disk (optional) Should the data be written to disk default is
 #' `TRUE` i.e. write the data to disk.
 #' @param anon_chi_out (Default:TRUE) Should `anon_chi` be used in the output
-#' (instead of chi)
+#' (instead of chi).
 #'
-#' @return a [tibble][tibble::tibble-package] containing the episode file
+#' @return the Source Episode file as a [tibble][tibble::tibble-package].
 #' @export
-#'
-run_episode_file <- function(
+create_episode_file <- function(
     processed_data_list,
     year,
     write_to_disk = TRUE,
@@ -134,7 +133,7 @@ run_episode_file <- function(
 #' Store the unneeded episode file variables
 #'
 #' @param data The in-progress episode file data.
-#' @inheritParams run_episode_file
+#' @inheritParams create_episode_file
 #' @param vars_to_keep a character vector of the variables to keep, all others
 #' will be stored.
 #'
@@ -172,7 +171,7 @@ store_ep_file_vars <- function(data, year, vars_to_keep) {
 
 #' Load the unneeded episode file variables
 #'
-#' @inheritParams run_episode_file
+#' @inheritParams create_episode_file
 #' @inheritParams store_ep_file_vars
 #'
 #' @return The full SLF data.

diff --git a/R/create_individual_file.R b/R/create_individual_file.R
@@ -1,11 +1,11 @@
-#' Create individual file
+#' Create the Source Individual file
 #'
-#' @description Creates individual file from episode file
+#' @description Creates the individual file from the episode file.
 #'
-#' @param episode_file Tibble containing episodic data
+#' @param episode_file Tibble containing episodic data.
 #' @param anon_chi_in (Default:TRUE) Is `anon_chi` used in the input
-#' (instead of chi)
-#' @inheritParams run_episode_file
+#' (instead of chi).
+#' @inheritParams create_episode_file
 #'
 #' @return The processed individual file
 #' @export

diff --git a/_targets.R b/_targets.R
@@ -545,7 +545,7 @@ list(
     ),
     tar_target(
       episode_file,
-      run_episode_file(
+      create_episode_file(
         processed_data_list,
         year,
         write_to_disk

diff --git a/man/add_acute_columns.Rd b/man/add_acute_columns.Rd
diff --git a/man/add_ae_columns.Rd b/man/add_ae_columns.Rd
diff --git a/man/add_all_columns.Rd b/man/add_all_columns.Rd
diff --git a/man/add_at_columns.Rd b/man/add_at_columns.Rd
diff --git a/man/add_ch_columns.Rd b/man/add_ch_columns.Rd
diff --git a/man/add_cij_columns.Rd b/man/add_cij_columns.Rd
diff --git a/man/add_cmh_columns.Rd b/man/add_cmh_columns.Rd
diff --git a/man/add_dd_columns.Rd b/man/add_dd_columns.Rd
diff --git a/man/add_dn_columns.Rd b/man/add_dn_columns.Rd
diff --git a/man/add_gls_columns.Rd b/man/add_gls_columns.Rd
diff --git a/man/add_hc_columns.Rd b/man/add_hc_columns.Rd
diff --git a/man/add_hl1_columns.Rd b/man/add_hl1_columns.Rd
diff --git a/man/add_ipdc_cols.Rd b/man/add_ipdc_cols.Rd
diff --git a/man/add_mat_columns.Rd b/man/add_mat_columns.Rd
diff --git a/man/add_mh_columns.Rd b/man/add_mh_columns.Rd
diff --git a/man/add_nrs_columns.Rd b/man/add_nrs_columns.Rd
diff --git a/man/add_nsu_columns.Rd b/man/add_nsu_columns.Rd
diff --git a/man/add_ooh_columns.Rd b/man/add_ooh_columns.Rd
diff --git a/man/add_op_columns.Rd b/man/add_op_columns.Rd
diff --git a/man/add_pis_columns.Rd b/man/add_pis_columns.Rd
diff --git a/man/add_sds_columns.Rd b/man/add_sds_columns.Rd
diff --git a/man/add_standard_cols.Rd b/man/add_standard_cols.Rd
diff --git a/man/aggregate_by_chi.Rd b/man/aggregate_by_chi.Rd
diff --git a/man/aggregate_ch_episodes.Rd b/man/aggregate_ch_episodes.Rd
diff --git a/man/clean_up_ch.Rd b/man/clean_up_ch.Rd
diff --git a/man/correct_cij_vars.Rd b/man/correct_cij_vars.Rd
diff --git a/man/create_cohort_lookups.Rd b/man/create_cohort_lookups.Rd
diff --git a/man/create_cost_inc_dna.Rd b/man/create_cost_inc_dna.Rd
diff --git a/man/run_episode_file.Rd → man/create_episode_file.Rd b/man/run_episode_file.Rd → man/create_episode_file.Rd
diff --git a/man/create_individual_file.Rd b/man/create_individual_file.Rd