R/readData_example.R

In jdgagnon/plotGrouper: Shiny app GUI wrapper for ggplot with built-in statistical analysis

# Copyright 2017-2018 John Gagnon
# This program is distributed under the terms of the GNU General Public License

#' Get path to readData example
#'
#' readData comes bundled with a example files in its `inst/applications/www`
#' directory. This function makes them easy to access.
#'
#' @param path Name of file. If `NULL`, the example files will be listed.
#' @return Located example excel file in package
#' @examples
#' readData_example(path = "iris.xlsx")
#' @export
readData_example <- function(path = NULL) {
  if (is.null(path)) {
    dir(system.file("application/www", package = "plotGrouper"))
  } else {
    system.file("application/www",
                path,
                package = "plotGrouper",
                mustWork = TRUE)
  }
}