Skip to content

Get path to vroom examples

Source: R/example.R
vroom_example.Rd

vroom comes bundled with a number of sample files in its 'inst/extdata' directory. Use vroom_examples() to list all the available examples and vroom_example() to retrieve the path to one example.

Usage

vroom_example(path)

vroom_examples(pattern = NULL)

Arguments

path

Name of file.

pattern

A regular expression of filenames to match. If NULL, all available files are returned.

Examples

# List all available examples
vroom_examples()
#>  [1] "fwf-sample.txt"       "mtcars-4.csv"         "mtcars-6.csv"        
#>  [4] "mtcars-8.csv"         "mtcars-multi-cyl.zip" "mtcars.csv"          
#>  [7] "mtcars.csv.bz2"       "mtcars.csv.gz"        "mtcars.csv.xz"       
#> [10] "mtcars.csv.zip"      

# Get path to one example
vroom_example("mtcars.csv")
#> [1] "/home/runner/work/_temp/Library/vroom/extdata/mtcars.csv"