R/shs_extract_metadata.R

In DataScienceScotland/shsannualreport: SHS Annual Report

#' Extract survey metadata from Excel
#'
#' \code{shs_extract_metadata} extracts survey metadata from Excel workbooks in a specified location,
#' and saves each sheet into a specified destination as an individual \code{.Rds} file.
#' Internal function for \code{shs_extract_data}.
#'
#' @param source_metadata_directory \code{string}.
#' The path of the directory containing survey metadata in Excel format.
#' @param metadata_directory \code{string}.
#' The path of the directory to be extracted to, created by \code{shs_extract_data}.
#'
#' @return \code{null}.
#'
#' @examples
#' \dontrun{
#' shs_extract_metadata(source_metadata_directory, metadata_directory)
#' }
#'
#' @keywords internal
#'
#' @noRd

shs_extract_metadata <- function(source_metadata_directory,
                                 metadata_directory) {

  files <- list.files(source_metadata_directory)

  for (file in files) {

    workbook_path <- file.path(source_metadata_directory, file)
    sheets <- readxl::excel_sheets(workbook_path)

    for (sheet in sheets) {

      df <- readxl::read_excel(workbook_path, sheet = sheet)
      saveRDS(df, file = file.path(metadata_directory,
                                   paste0(sheet, ".Rds")))
    }
  }
}