warn_filter_over_gaps: Warn (once per run) that a filter/resampling step is...

In eyeris: Flexible, Extensible, & Reproducible Pupillometry Preprocessing

Warn (once per run) that a filter/resampling step is operating over gaps

Description

Emits a one-time-per-run warning explaining that a step which relies on filtering (e.g. lpfilt() or the anti-aliasing filter in downsample()) is operating over long gaps that interpolate(max_gap_ms) left as NA. Because those gaps are temporarily filled to let the filter run and then masked back to NA, the filter can slightly bias the valid samples immediately adjacent to each gap toward the interpolated values. Users may prefer to disable filtering and/or downsampling. The flag is cleared by reset_gap_notices(), which glassbox() calls at the start of each run.

Usage

warn_filter_over_gaps(step)

Arguments

step	Character label of the calling step (e.g. "lpfilt", "downsample"), used both in the message and to fire the notice only once per run per step

Value

Invisibly returns NULL

eyeris documentation built on Aug. 1, 2026, 1:07 a.m.