make_prog_summary_plot: Create progressive preprocessing summary plot

In eyeris: Flexible, Extensible, & Reproducible Pupillometry Preprocessing

Create progressive preprocessing summary plot

Description

Internal function to create a comprehensive visualization showing the progressive effects of preprocessing steps on pupil data. This plot displays multiple preprocessing stages overlaid on the same time series, allowing users to see how each step modifies the pupil signal.

Usage

make_prog_summary_plot(
  pupil_data,
  pupil_steps,
  preview_n = 3,
  plot_params = list(),
  run_id = "run-01",
  cex = 2
)

Arguments

pupil_data	A data frame containing pupil timeseries data with multiple preprocessing columns (e.g., eyeris$timeseries$block_1)
pupil_steps	Character vector of column names containing pupil data at different preprocessing stages (e.g., c("pupil_raw", "pupil_deblink", "pupil_detrend"))
preview_n	Number of columns for subplot layout. Defaults to 3
plot_params	Named list of additional parameters to forward to plotting functions. Defaults to list()
run_id	Character string identifying the run/block (e.g., "run-01"). Used for plot titles and file naming. Defaults to "run-01"
cex	Character expansion factor for plot elements. Defaults to 2.0

Details

This function creates a two-panel visualization:

• Top panel: Overlaid time series showing progressive preprocessing effects with different colors for each step

• Bottom panel: Legend identifying each preprocessing step

The plot excludes z-scored data (columns ending with "_z") and only includes steps with sufficient valid data points (>100). Each preprocessing step is displayed with a distinct color, making it easy to see how the signal changes through the pipeline.

Value

NULL (invisibly). Creates a plot showing progressive preprocessing effects with multiple layers overlaid on the same time series

See Also

plot.eyeris

eyeris documentation built on July 3, 2025, 9:08 a.m.