Package: eyetools 0.8.1

eyetools: Analyse Eye Data

Enables the automation of actions across the pipeline, including initial steps of transforming binocular data and gap repair to event-based processing such as fixations, saccades, and entry/duration in Areas of Interest (AOIs). It also offers visualisation of eye movement and AOI entries. These tools take relatively raw (trial, time, x, and y form) data and can be used to return fixations, saccades, and AOI entries and time spent in AOIs. As the tools rely on this basic data format, the functions can work with data from any eye tracking device. Implements fixation and saccade detection using methods proposed by Salvucci and Goldberg (2000) <doi:10.1145/355017.355028>.

Authors:Tom Beesley [aut, cre], Matthew Ivory [aut]

eyetools_0.8.1.tar.gz
eyetools_0.8.1.zip(r-4.5)eyetools_0.8.1.zip(r-4.4)eyetools_0.8.1.zip(r-4.3)
eyetools_0.8.1.tgz(r-4.5-any)eyetools_0.8.1.tgz(r-4.4-any)eyetools_0.8.1.tgz(r-4.3-any)
eyetools_0.8.1.tar.gz(r-4.5-noble)eyetools_0.8.1.tar.gz(r-4.4-noble)
eyetools_0.8.1.tgz(r-4.4-emscripten)eyetools_0.8.1.tgz(r-4.3-emscripten)
eyetools.pdf |eyetools.html✨
eyetools/json (API)
NEWS

# Install 'eyetools' in R:
install.packages('eyetools', repos = c('https://tombeesley.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/tombeesley/eyetools/issues

Pkgdown site:https://tombeesley.github.io

Datasets:
  • HCL - Example dataset from that contains binocular eye data from two participants from a simple contingency learning task (the data are from Beesley, Nguyen, Pearson, & Le Pelley, 2015). In this task there are two stimuli that appear simultaneously on each trial (to the left and right of the screen). Participants look at these cues and then make a decision by selecting an "outcome response" button.
  • HCL_AOIs - Example AOIs for use with HCL
  • HCL_behavioural - Example dataset of behavioural data to complement dataset HCL.

On CRAN:

areas-of-interestattention-visualizationcognitive-sciencedwell-time-algorithmeye-trackereye-trackingeyetrackingggplot2psychologypsychology-experimentssaccadestobiitobii-eye-trackervisualization

5.45 score 4 stars 8 scripts 246 downloads 19 exports 46 dependencies

Last updated 2 months agofrom:4c9f76b96f. Checks:8 OK. Indexed: yes.

TargetResultLatest binary
Doc / VignettesOKFeb 17 2025
R-4.5-winOKFeb 17 2025
R-4.5-macOKFeb 17 2025
R-4.5-linuxOKFeb 17 2025
R-4.4-winOKFeb 17 2025
R-4.4-macOKFeb 17 2025
R-4.3-winOKFeb 17 2025
R-4.3-macOKFeb 17 2025

Exports:AOI_seqAOI_timeAOI_time_binnedcombine_eyescompare_algorithmsconditional_transformcreate_AOI_dfdist_to_visual_anglefixation_dispersionfixation_VTIhdf5_get_eventhdf5_to_dfinterpolateplot_AOI_growthplot_heatmapplot_seqplot_spatialsaccade_VTIsmoother

Dependencies:bitbit64clicolorspacecpp11curlfansifarverggforceggplot2gluegridExtragtablehdf5risobandjsonlitelabelinglatticelifecyclemagickmagrittrMASSMatrixmgcvmunsellnlmepbapplypillarpkgconfigpolyclipR6RColorBrewerRcppRcppEigenrlangscalessystemfontstibbletidyselecttweenrutf8vctrsviridisviridisLitewithrzoo

An introduction to eyetools

Matthew Ivory, Tom Beesley

Rendered fromeyetools.Rmdusingknitr::rmarkdownon Feb 17 2025.

Last update: 2024-12-19
Started: 2024-09-26

Readme and manuals

Help Manual

Help pageTopics
Sequence analysis of area of interest entriesAOI_seq
Time analysis of area of interest entriesAOI_time
Binned time analysis of area of interest entriesAOI_time_binned
Combine binocular data into single X/Y coordinate pairscombine_eyes
A battery of metrics and plots to compare the two algorithms (dispersion and VTI)compare_algorithms
conditional_transformconditional_transform
Create a blank data frame for populating with AOIscreate_AOI_df
Compute visual angle from distance metricsdist_to_visual_angle
Fixation detection using a dispersion methodfixation_dispersion
Fixation detection using a velocity threshold identification methodfixation_VTI
Example dataset from that contains binocular eye data from two participants from a simple contingency learning task (the data are from Beesley, Nguyen, Pearson, & Le Pelley, 2015). In this task there are two stimuli that appear simultaneously on each trial (to the left and right of the screen). Participants look at these cues and then make a decision by selecting an "outcome response" button.HCL
Example AOIs for use with HCLHCL_AOIs
Example dataset of behavioural data to complement dataset HCL.HCL_behavioural
Get messgaes stored in TOBII-generated HDF5 fileshdf5_get_event
Convert TOBII-generated HDF5 files to dataframehdf5_to_df
Interpolation of missing data (NAs)interpolate
Plots absolute or proportional time spent in AOIs over timeplot_AOI_growth
Plot heatmap of raw dataplot_heatmap
Plot of raw data over timeplot_seq
Plot raw data and fixationsplot_spatial
Velocity threshold identification of saccadessaccade_VTI
Smoothing of raw datasmoother