R/read_booklog.R

In ricompute/bookr: Keeps a Log of Read Books

#' Read booklog.csv into a Data Frame
#'
#' This is just a wrapper around read.csv to read booklog.csv into a data frame.
#' @param file A character string containing the name of the file to be read in, or a file connection. Defaults to booklog.csv.
#' @param ... Further arguments to be passed to read.csv.
#'
#' @return Returns a data frame with the contents of booklog.csv.
#' @export
#'
#' @examples
#' blg <- read_booklog()

read_booklog <- function(file = "booklog.csv", ...) {

        # Check to see if booklog.csv exists
        if (!file.exists(file)) {
                stop(file, " does not exist!")
        }

        # Read in booklog.csv
        read.csv(file, stringsAsFactors = FALSE, ...)
}