R/example.R

Defines functions zip_example

Documented in zip_example

#' Get path to zippr example
#'
#' zippr comes bundled with a sample archive in its `inst/extdata` directory.
#' This function make it easy to access.
#'
#' @examples
#' zip_example()
#' @importFrom fs fs_path
#' @export
zip_example <- function() {
  zipfile <- system.file(
    "extdata", "example.zip",
    package = "zippr",
    mustWork = TRUE
  )
  fs::fs_path(zipfile)
}
kiernann/zippr documentation built on Feb. 17, 2021, 5:59 p.m.