interpolate {eyeris} | R Documentation |
Interpolate missing pupil samples
Description
Linear interpolation of time series data. The intended use of this method
is for filling in missing pupil samples (NAs) in the time series. This method
uses "na.approx()" function from the zoo package, which implements linear
interpolation using the "approx()" function from the stats package.
Currently, NAs at the beginning and the end of the data are replaced with
values on either end, respectively, using the "rule = 2" argument in the
approx()
function.
Usage
interpolate(eyeris, verbose = TRUE, call_info = NULL)
Arguments
eyeris |
An object of class |
verbose |
A flag to indicate whether to print detailed logging messages.
Defaults to |
call_info |
A list of call information and parameters. If not provided, it will be generated from the function call |
Details
This function is automatically called by glassbox()
by default. Use
glassbox(interpolate = FALSE)
to disable this step as needed.
Users should prefer using glassbox()
rather than invoking this function
directly unless they have a specific reason to customize the pipeline
manually.
Value
An eyeris
object with a new column in timeseries
:
pupil_raw_{...}_interpolate
Note
This function is part of the glassbox()
preprocessing pipeline and is not
intended for direct use in most cases. Use glassbox(interpolate = TRUE)
.
Advanced users may call it directly if needed.
See Also
glassbox()
for the recommended way to run this step as
part of the full eyeris glassbox preprocessing pipeline.
Examples
demo_data <- eyelink_asc_demo_dataset()
demo_data |>
# set to FALSE to skip (not recommended)
eyeris::glassbox(interpolate = TRUE) |>
plot(seed = 0)