eyewit

Tobii Eyetracking Utility Functions

An R package for pre-processing raw eye-tracking data around Tobii's I-VT Fixation Filter

Installation

devtools::install_github("ccp-eva/eyewit/eyewit")

Or specific release/tag, e.g,:
devtools::install_github("ccp-eva/eyewit/eyewit@v0.3.6")

What’s Happening

eyewit Roadmap

Release 0.5

Progress is tracked here: https://github.com/ccp-eva/eyewit/projects/4 Now that eyewit is an actual R package, I need to address the following points:

• [ ] Allmost all functions need proper documentation
• [ ] Many functions need unit tests
• [ ] Refactor functions (espacially get_looks)

Release 0.6

Progress is tracked here: https://github.com/ccp-eva/eyewit/projects/8

January 2022

• [x] Successfully converted to an R package (devtools::install_github("ccp-eva/eyewit/eyewit"))

Common Abbreviations

Those abbreviations are used either in the docs or in the code...

Functions

Fixation Index Summary

The function fi

As of January 2022, functions are being refactored and documented in their corresponding helper files. This table will is out of date and will be removed!

| Objects | Description | | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | interface | Contains user defined parameters for the experiment: raw files directory, x, y column names, AOI information, etc. | | preflight() | Takes a df and the interface as input and performs several checks (check for required columns, fix column names, check that rownames are in an incremental order (i.e., no missing rows or prior pre-processing), check if single AOIs are not overlapping | | getstartendpos() | Returns a list of start and end positions for a given df and a regex pattern. Those position pairs define usually a trial | | gettrialcount() | Based on a single or multiple provided trialscopes, the function calculates the trial count | | allocatetrials() | Creates an enumerated "Trial" column in the provided df for a single or multiple trialscopes | | getaois() | To be documented | | fi2rn() | To be documented | | getgazeshiftlatency() | To be documented | | valueparserbykey() | To be documented | | getlooks | To be documented & To be refactored | | getfirstfreefi() | Utility function for getlooks() (specifically for omit_first_overflow_fi parameter) | | getlookawayscopeend() | Utility function for getlooks() (specifically for lookaway_stop parameter) | | getnonfixationdata() | To be documented | | getobjects() | To be documented | | getpreflookpos() | To be documented, (legacy, tailor-made function) | | isaoilistoverlapping() | Part of the preflight() to check overlapping aois | | ishitnameinrange() | Returns TRUE/FALSE for a given vec, target hitname, fixation start index, and fixation stop index | | mergestartendchunks() | Utility function for gettrialcount() and allocatetrials() |

Contribution

Feel free to open PRs or discuss enhancements and code reviews