R/extract_abs_sheets.R

In MattCowgill/getabs: Download And Tidy Time Series Data From The Australian Bureau Of Statistics

#' Extract data sheets from an ABS timeseries workbook saved locally as an
#' .xls file.
#'
#' Note that this function will not tidy the data for you. Use `read_abs_local()`
#' to import and tidy data from local ABS time series spreadsheets or `read_abs()`
#' to download, import and tidy ABS time series.
#'
#' @param filename Filename for an ABS time series spreadsheet (as string), such as
#' "6202002.xls".
#'
#' @param table_title String giving the full title of the ABS table, such as
#' "Table 1. Employed persons, Australia"
#'
#' @param path Local directory in which an ABS time series is stored. Default is
#' "data/ABS"
#'
#' @importFrom readxl excel_sheets read_xls
#' @importFrom tibble tibble
#' @importFrom dplyr filter "%>%"
#' @importFrom purrr map set_names
#' @importFrom tools file_path_sans_ext
#' @export

extract_abs_sheets <- function(filename, table_title = NULL, path = "data/ABS"){

  .=sheet=NULL

  filename <- paste0(path, "/", filename)

  sheets <- readxl::excel_sheets(path = filename) %>%
    tibble::tibble(sheet = .) %>%
    dplyr::filter(!sheet %in% c("Index", "Inquiries"))

  if(nrow(sheets) < 1){
    stop(sprintf("The Excel workbook %s appears to have no data sheets.", filename))
  }

  data_sheets <- purrr::map(.x = sheets$sheet,
                            .f = readxl::read_xls,
                            path = filename,
                            trim_ws = TRUE,
                            .name_repair = "minimal") %>%
    purrr::set_names(paste0(tools::file_path_sans_ext(basename(filename)), "=",
                            sheets$sheet, "=",
                            table_title))

  data_sheets
}