R/read_excel_allsheets.R

In notsynonymous/SWA: A package to assist in devloping SEM metrics based on driver data

#' Reads a workbook to a multidimensional matrix
#' This is a function to take a workbook and transform it into a multidimensional matrix. This function was created by Jeromy Anglim.
#' @name read_excel_allsheets
#'
#' @author Jeromy Anglim
#'
#' @importFrom readxl excel_sheets read_excel
#'
#' @param filename a vector of type string and length 1 that takes the name of a file
#' @param tibble a logical argument that uses tibbles instead of dataframes if set to TRUE
#'
#' @returns None
#' 
#' @examples
#' \dontrun{
#' setwd(PATH_TO_FOLDER)
#' read_excel_allshets(filename)
#' }
#' @export
#' @md

read_excel_allsheets <- function(filename, tibble = FALSE) {

    sheets <- excel_sheets(filename)
    x <- lapply(sheets, function(X) read_excel(filename, sheet = X))
    if(!tibble) x <- lapply(x, as.data.frame)
    names(x) <- sheets
    x
	
}