R/readData.R

In jr-leary7/YehLabHTS: This package makes the Yeh Lab's HTS drug discovery analyses reproducible.

#' Read .xlsx HTS data
#'
#' This function reads in a `.xlsx` file, and outputs the name of the file being read before returning it. Useful for keeping track of data in large `for` loops.
#' @param parent.dir The directory within which the .xlsx file is located.
#' @param file.name The .xlsx file you wish to load.
#' @param sheet.name Which sheet to load.
#' @param col.names Should column names be loaded? Defaults to TRUE.
#' @importFrom openxlsx read.xlsx
#' @export
#' @examples
#' readData(parent.dir = "path/to/data/dir/", sheet.name = 1, file.name = "file.xlsx")

readData <- function(parent.dir, file.name, sheet.name = 1, col.names = TRUE) {
  filepath <- sprintf("%s%s.xlsx",
                      parent.dir,
                      file.name)
  sprintf("Reading file: %s", file.name)
  df <- read.xlsx(filepath,
                  sheet = sheet.name,
                  colNames = col.names)
  return(df)
}