eyeris: Flexible, Extensible, & Reproducible Processing of Pupil Data

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 (see 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 unfortunately lack design patterns based on Findability, Accessibility, Interoperability, and Reusability (FAIR) principles (see Wilkinson et al., 2016 <doi:10.1038/sdata.2016.18> for more information). 'eyeris', on the other hand, follows a design philosophy that provides users with an intuitive, modular, performant, and extensible pupillometry data preprocessing framework out-of-the-box. 'eyeris' introduces a Brain Imaging Data Structure (BIDS)-like organization for derivative (i.e., preprocessed) pupillometry data as well as an intuitive workflow for inspecting preprocessed pupil epochs using interactive output report files (Esteban et al., 2019 <doi:10.1038/s41592-018-0235-4>; Gorgolewski et al., 2016 <doi:10.1038/sdata.2016.44>).

Version: 1.0.0
Depends: R (≥ 4.1)
Imports: eyelinker, dplyr, gsignal, purrr, zoo, cli, rlang, stringr, utils, stats, graphics, grDevices, tidyr, progress, data.table, withr
Suggests: knitr, rmarkdown, testthat (≥ 3.0.0)
Published: 2025-03-31
DOI: 10.32614/CRAN.package.eyeris
Author: Shawn Schwartz ORCID iD [aut, cre, cph]
Maintainer: Shawn Schwartz <stschwartz at stanford.edu>
BugReports: https://github.com/shawntz/eyeris/issues
License: MIT + file LICENSE
URL: https://shawnschwartz.com/eyeris/, https://github.com/shawntz/eyeris/
NeedsCompilation: no
Materials: README NEWS
CRAN checks: eyeris results

Documentation:

Reference manual: eyeris.pdf
Vignettes: Anatomy of an eyeris Object (source, R code)
Complete Pupillometry Pipeline Walkthrough (source, R code)
Building Your Own Custom Pipeline Extensions (source, R code)
Extracting Data Epochs and Exporting Pupil Data (source, R code)
QC with Interactive Reports (source, R code)

Downloads:

Package source: eyeris_1.0.0.tar.gz
Windows binaries: r-devel: eyeris_1.0.0.zip, r-release: not available, r-oldrel: not available
macOS binaries: r-devel (arm64): eyeris_1.0.0.tgz, r-release (arm64): eyeris_1.0.0.tgz, r-oldrel (arm64): eyeris_1.0.0.tgz, r-devel (x86_64): eyeris_1.0.0.tgz, r-release (x86_64): eyeris_1.0.0.tgz, r-oldrel (x86_64): eyeris_1.0.0.tgz

Linking:

Please use the canonical form https://CRAN.R-project.org/package=eyeris to link to this page.