R/gen_file_path.R

In Moohan/slfhelper: Useful functions for working with the Source Linkage Files

#' Generate a Source Linkage File, file path
#'
#' @inheritParams read_slf
#'
#' @param call Supply environment from the top-level function to make any error
#' messages more useful.
#' @param dev Whether to get the file from the development area
#' (`/conf/sourcedev/Source_Linkage_File_Updates`).
#' The default (`FALSE`) will get the production file from the usual area.
#' @param ext `r lifecycle::badge("questioning")` The file extension to read.
#'
#' @return a [fs_path][fs::fs-package] object.
gen_file_path <- function(
    year,
    file_version,
    call,
    dev = FALSE,
    ext = "parquet") {
  file_version <- match.arg(file_version, c("episode", "individual"))
  ext <- match.arg(ext, c("fst", "parquet"))

  # Clean up year
  # We want it in the format 1718
  # This will handle numbers or strings of the form 201718 or 1718
  if (!all(check_year(year, call = call))) {
    cli::cli_alert_info(
      "{.val {year}} is no longer updated and the data should be treated with
      caution."
    )
  }
  year <- format_year(year)

  if (!dev) {
    file_dir <- fs::path(
      "/",
      "conf",
      "hscdiip",
      "01-Source-linkage-files"
    )
  } else if (dev) {
    if (!check_has_access(group = "sourcedev")) {
      cli::cli_abort(
        c("x" = "You must have access to {.path /conf/sourcedev} to use the
        in-development version of the files. If you think this is a mistake,
        please contact the SLF team."),
        call = call
      )
    }
    dev_file_message <- c("i" = "You are using the in-development version of the SLFs.")
    if (check_has_access(group = "hscdiip_sl")) {
      cli::cli_inform(
        message = dev_file_message,
        call = call,
        .frequency = "once",
        .frequency_id = "dev_files"
      )
    } else {
      cli::cli_warn(
        message = dev_file_message,
        call = call,
        .frequency = "once",
        .frequency_id = "dev_files"
      )
    }
    file_dir <- fs::path(
      "/",
      "conf",
      "sourcedev",
      "Source_Linkage_File_Updates",
      year
    )
  }

  file_path <- fs::path(
    file_dir,
    stringr::str_glue("source-{file_version}-file-{year}"),
    ext = ext
  )

  return(file_path)
}