Detrend the pupil time series

Linearly detrend_pupil data by fitting a linear model of pupil_data ~ time, and return the fitted betas and the residuals (pupil_data - fitted_values).

Usage

detrend(eyeris, call_info = NULL)

Arguments

eyeris: An object of class eyeris derived from load_asc()
call_info: A list of call information and parameters. If not provided, it will be generated from the function call. Defaults to NULL

Value

An eyeris object with two new columns in timeseries: detrend_fitted_betas, and pupil_raw_{...}_detrend

Details

This function is automatically called by glassbox() if detrend = TRUE.

Users should prefer using glassbox() rather than invoking this function directly unless they have a specific reason to customize the pipeline manually.

Note

This function is part of the glassbox() preprocessing pipeline and is not intended for direct use in most cases. Use glassbox(detrend = TRUE).

Advanced users may call it directly if needed.

Examples

demo_data <- eyelink_asc_demo_dataset()

demo_data |>
  eyeris::glassbox(detrend = TRUE) |>  # set to FALSE to skip step (default)
  plot(seed = 0)
#> ✔ [  OK  ] - Running eyeris::load_asc()
#> ℹ [ INFO ] - Processing block: block_1
#> ✔ [  OK  ] - Running eyeris::deblink() for block_1
#> ✔ [  OK  ] - Running eyeris::detransient() for block_1
#> ✔ [  OK  ] - Running eyeris::interpolate() for block_1
#> ✔ [  OK  ] - Running eyeris::lpfilt() for block_1

#> ! [ SKIP ] - Skipping eyeris::downsample() for block_1
#> ! [ SKIP ] - Skipping eyeris::bin() for block_1
#> ✔ [  OK  ] - Running eyeris::detrend() for block_1
#> ✔ [  OK  ] - Running eyeris::zscore() for block_1
#> 
#> Block processing summary:
#>   block_1: OK (steps: 7, latest: pupil_raw_deblink_detransient_interpolate_lpfilt_detrend_z)
#> 
#> ✔ [  OK  ] - Running eyeris::summarize_confounds()
#> ! [ INFO ] - Plotting block 1 from possible blocks: 1
#> ℹ [ INFO ] - Plotting with sampling rate: 1000 Hz