Changelog

Source: NEWS.md

pupillometry 0.8.1

Updated: 08/25/2022

  • Added support for Tobii eye trackers! pupil_read(eyetracker = "tobii")

pupillometry 0.8.0

DOI

Tsukahara, J.S. (2022). pupillometry: An R package to preprocess pupil data (v0.8.0). http://doi.org/10.5281/zenodo.6661649

Updated: 06/18/2022

  • Major release update

  • Speed improvement!: Converted the functions to use dtplyr (a dplyr translation for using and taking advantage of data.table which can handle larger data at faster speeds). This should result in improvements in speed. There was also an issue before where if a trial had large amounts of missing data the functions (namely pupil_artifact) would get stuck and never finish processing and a reboot of R was required. This seems to take care of that issue too.

  • Added the option to keep and preprocess data from both the left and right eyes. Averaging of the pupil data from each eye can be down after preprocessing. pupil_read(eye_use = NULL) is now default and will preserve pupil data from both eyes. If you have only data from the left or right eye, using the default (NULL) will work so no need to specify the recorded from eye.

pupillometry 0.7.0

DOI

Tsukahara, J.S. (2022). pupillometry: An R package to preprocess pupil data (v0.7.0). http://doi.org/10.5281/zenodo.6216399

Updated: 02/22/2022

  • Major release update

  • Added a function, pupil_artifact(), to remove unlikely pupil values (artifact removal) based on the median absolute deviation suggested by Geller et al. (2020) and Kret and Sjak-Shie (2019)

  • Added a function, pupil_upsample(), to up-sample the data to 1000Hz based on Kret and Sjak-Shie (2019)

  • Added plot argument options to plot the data before and after:

    • pupil_deblink(plot = TRUE, plot_trial = c(1,2,3))

    • pupil_artifact(plot = TRUE, plot_trial = c(1,2,3))

    • pupil_smooth(plot = TRUE, plot_trial = c(1,2,3))

    • pupil_interpolate(plot = TRUE, plot_trial = c(1,2,3))

  • Streamlined pupil_read()

  • Removed the GUI option, pupil_gui() (it might come back in a future update)

  • pupil_preprocess() is still there but is not recommended to use

  • Renamed some arguments and functions to be more consistent and simple

References:

Geller, J., Winn, M. B., Mahr, T., & Mirman, D. (2020). GazeR: A Package for Processing Gaze Position and Pupil Size Data. Behavior Research Methods, 52(5), 2232–2255. https://doi.org/10.3758/s13428-020-01374-8

Kret, M. E., & Sjak-Shie, E. E. (2019). Preprocessing pupil size data: Guidelines and code. Behavior Research Methods, 51(3), 1336–1342. https://doi.org/10.3758/s13428-018-1075-y

pupillometry 0.6.0

Updated: 10/22/2021

  • Added support for any eye tracker data file.

    Leave the eyetracker argument at the default value ""

    You need to specify which column names go to which variable (e.g., GazePoint systems left_pupil.mm = "LPMM"). See pupil_read()

pupillometry 0.5.0

DOI

Tsukahara, J.S. (2022). pupillometry: An R package to preprocess pupil data (v0.5.0). http://doi.org/10.5281/zenodo.4464854

Updated: 05/24/2020

  • Added a GUI for pupil_preprocess()!

  • Updated support for SR-Research EyeLink 1000 eye tracker

  • Renamed some of the parameters (old parameter names may not work)

  • Added a quality check in pupil_read() to make sure trials were set correctly

    A file “quality_check.csv” will be saved to the output_dir with the number of trials in each data file.

    At the end of pupil_preprocess() the quality check will be printed to the console.

    Future updates will include other quality checks and logs.

  • Added tidyselect as a dependency

pupillometry 0.4.1

Updated: 10/21/2019

  • Full support for SR-Research EyeLink 1000 eyetracker eyetracker = "eyelink"

  • Added parameter to include conversion factor of pupil data in pixels (px) to pupil data in millimeters (mm) px_to_mm.conversion

  • Renamed some of the parameters (old parameter names still work)

pupillometry 0.4.0

Updated: 09/30/2019

  • Added the functionality to supply a timing file in order to insert Message Markers in the data. See Example Data - Without Message Markers

  • Added support for SMI Eyeglasses

  • Changed argument startrecording.message to starttracking.message

  • Created better documentation

pupillometry 0.3.0

Updated: 05/15/2019

  • Added pupil_merge()

  • Added parameter to pupil_preprocess(files.merge = TRUE) to create a single merged output file.

  • Added pupil_deblink() with the parameter option extend

  • Added option to not save data file at each step of preprocessing with paramter argument pupil_preprocess(output.steps = FALSE).

  • Reduced the number of parameters in pupil_preprocess()

  • Changed preprocess() to pupil_preprocess()

  • Changed tidy_eyetracker() to pupil_read()

  • Changed pupil_eye() to select_eye()

pupillometry 0.2.1

Updated: 11/13/2018

  • Changed function names to use “_” rather than “.”

    “.” functions can still be used but have been deprecated.

  • Added aoi_downsample() function

pupillometry 0.2.0

Updated: 10/13/2018

  • Important update that fixes several bugs

  • Smoothing function was also interpolating. This has been fixed.

  • Added plot.comparison() to visually compare different preprocessing parameters in a convenient way

  • Added pupil.eye() to simplify selecting which eye to use in the final output.

  • Added parameter missing.allowed to preprocess() and pupil.missing() to filter out trials with too much missing data.

  • Added gazedata.include() parameter to import and output gaze position x and y coordinates from original raw data file

  • Other bug fixes and minor changes

pupillometry 0.1.1

Updated: 10/11/2018

  • Added the option to do “divisive” baseline correction

    Paramaters added: preprocess(bc.type = c("subtractive", "divisive")) and pupil.baselinecorrect(bc.type = c("subtractive", "divisive"))

    Default: “subtractive”

  • More flexibility to choose the ordering of interpolation and smoothing in preprocess()

    Paramaters added: preprocess(method.first = c("smooth", "interpolate"))

  • More precise specifications to obtain Subject # from the file name.

    Paramaters added: preprocess(subj.prefix = NULL, subj.suffix = NULL) and tidy_eyetracker(subj.prefix = NULL, subj.suffix = NULL)

    If parameters are set as NULL (default), then the entire file name will be used as the Subject #. This is not ideal.

pupillometry 0.1.0

Updated: 10/7/2018

New Features

  • Added startrecording.match parameter to preprocess() and tidy_eyetracker()

  • Added match paramter to set.trial()

    This allows the user to specify whether the startrecording.message is an “exact” or “pattern” match. Default is “exact” match.

Added Support

  • Impproved support for EyeLink 1000 Plus eyetrackers