R/tor_example.R

In tor: Import Multiple Files From a Single Directory at Once

#' Easily access example data.
#'
#' @author Copied from `readr_example()` from the __readr__ package, by Jim
#'   Hester and colleagues.
#'
#' @param path Length-1 character vector. A path to an available directory.
#'
#' @return A character string listing available directories or a length-1 string
#'   giving a path to a directory.
#'
#' @examples
#' tor_example()
#'
#' tor_example("csv")
#'
#' dir(tor_example("csv"))
#' @family helpers
#' @export
tor_example <- function(path = NULL) {
  if (is.null(path)) {
    dir(system.file("extdata", package = "tor"))
  } else {
    system.file("extdata", path, package = "tor", mustWork = TRUE)
  }
}