forceR_example: Get path to forceR example

In Peter-T-Ruehr/forceR: Force Measurement Analyses

Get path to forceR example

Description

forceR comes with example files of short bite force measurements. The files are stored in ⁠forceR's⁠ inst/extdata folder, and this function returns the path to that folder or one of the files so they can be used in examples.

Usage

forceR_example(type = "folder")

Arguments

type	A character string (either "folder", "raw", or "ampdriftcorr") defining if the path returned be the function should point to one of the the example files or the folder containing them. Default: "folder".

Value

If type = "folder": returns the file path to the folder containing BF_raw.csv and BF_ampdriftcorr.csv.

If type = "LJStream": returns the file path to BF_raw.csv, which contains a short bite force raw measurement.

If type = "raw": returns the file path to BF_raw.csv, which contains a short bite force raw measurement.

If type = "ampdriftcorr": returns the file path to BF_ampdriftcorr.csv, which contains a short bite force raw measurement where the amplifier drift as been corrected for by the amp_drift_corr() funcion.

Peter-T-Ruehr/forceR documentation built on March 25, 2024, 1:30 a.m.