spiro_example: Get path to spiro example

View source: R/spiro_example.R

spiro_exampleR Documentation

Get path to spiro example

Description

spiro_example returns the file path for example data files within the spiro package.

Usage

spiro_example(file = NULL)

Arguments

file

Name of the file, either "zan_gxt", "zan_ramp" or "hr_ramp.tcx". Leave the argument empty to get a vector with the paths of all three example files.

Value

A character vector with the absolute file path of the example file(s).

Examples

# get path of a specific example data file
spiro_example("zan_gxt")

# get all paths of example data files
spiro_example()

spiro documentation built on Aug. 14, 2023, 5:07 p.m.