plot_detrend_overlay

This function replicates the exact detrending visualization from the
<code>glassbox()</code> interactive preview mode. It uses <code>robust_plot()</code> to show the
most recent detrended pupil signal overlaid with the fitted linear trend.

internal

Pupillometry offers a non-invasive window into the mind and has been used extensively as a psychophysiological readout of arousal signals linked with cognitive processes like attention, stress, and emotional states [Clewett et al. (2020) <doi:10.1038/s41467-020-17851-9>; Kret & Sjak-Shie (2018) <doi:10.3758/s13428-018-1075-y>; Strauch (2024) <doi:10.1016/j.tins.2024.06.002>]. Yet, despite decades of pupillometry research, many established packages and workflows to date lack design patterns based on Findability, Accessibility, Interoperability, and Reusability (FAIR) principles [see Wilkinson et al. (2016) <doi:10.1038/sdata.2016.18>]. 'eyeris' provides a modular, performant, and extensible preprocessing framework for pupillometry data with BIDS-like organization and interactive output reports [Esteban et al. (2019) <doi:10.1038/s41592-018-0235-4>; Gorgolewski et al. (2016) <doi:10.1038/sdata.2016.44>]. Development was supported, in part, by the Stanford Wu Tsai Human Performance Alliance, Stanford Ric Weiland Graduate Fellowship, Stanford Center for Mind, Brain, Computation and Technology, NIH National Institute on Aging Grants (R01-AG065255, R01-AG079345), NSF GRFP (DGE-2146755), McKnight Brain Research Foundation Clinical Translational Research Scholarship in Cognitive Aging and Age-Related Memory Loss, American Brain Foundation, and the American Academy of Neurology.

Shawn Schwartz

eyeris

Flexible, Extensible, & Reproducible Pupillometry Preprocessing

plot_detrend_overlay function

<dl><dt>pupil_data</dt>
<dd>A single block of pupil timeseries data
(e.g. <code>eyeris$timeseries$block_1</code>)</dd>
<dt>preview_n</dt>
<dd>Number of columns for <code>par(mfrow)</code>. Default = 3.</dd>
<dt>plot_params</dt>
<dd>A named list of additional parameters to forward to
<code>robust_plot()</code></dd>
<dt>suppress_prompt</dt>
<dd>Logical. Whether to skip prompting. Default = TRUE.</dd></dl>

Arguments

Internal helper to plot detrending overlay — plot_detrend_overlay

<dl>

<dt>pupil_data</dt>
<dd>A single block of pupil timeseries data
(e.g. <code>eyeris$timeseries$block_1</code>)</dd>


<dt>preview_n</dt>
<dd>Number of columns for <code>par(mfrow)</code>. Default = 3.</dd>


<dt>plot_params</dt>
<dd>A named list of additional parameters to forward to
<code>robust_plot()</code></dd>


<dt>suppress_prompt</dt>
<dd>Logical. Whether to skip prompting. Default = TRUE.</dd>

</dl>

plot_detrend_overlay: Internal helper to plot detrending overlay

Description

Usage

Value

Arguments