README.md

In davebraze/FDBeye: Functions to Ease Work with Eyetracker Data

FDBeye

This is a collection of tools to ease working with eyetracker data. I'm slowly migrating stuff from my collection of project specific code into this package. FDBeye is about post-acquisition data processing. What's here now is focused on my own workflows involving data from SRR Eyelink systems, although some stuff may be more generally useful. This package is most definitely a work in progress. Keep that in mind if you make use of it. Pitch in and help with development if you like (see Contributing).

Before you try FDBeye, you might want to look at what else is available. See the list of eye tracking tools on the project wiki.

Installing FDBeye

To get the very latest from FDBeye, install it via devtools::install_github(). Some people have reported problems with the installation due to the vignettes failing to build. If that happens to you, you can try again with build_vignettes=FALSE, although the vignettes won't be available.

install.packages("devtools")    ## if you don't already have it
library(devtools)
install_github("davebraze/FDBeye", build_vignettes=TRUE)

On the other hand, if you want a (possibly) more stable experience. Download the most current release. Then install it like this:

install.packages(pathToFile, repos = NULL)

Where pathToFile is the full path and file name for the file you downloaded.

Copyright & License

FDBeye is released under the MIT License.

Keeping up with Changes

FDBeye development proceeds sporadically. If you want to be notified of any updates, then you can "watch" the github repository. If you already have a github account, this is as easy as clicking a button. If you don't have a github account, maybe it's time to sign up for one.

Contributing

Contributions are welcome, but you might want to review the "issues" page and send me an email before wading in too deep ([e-mail]). You might also have look at the file CONTRIBUTING.md for pointers on the mechanical details of contributing to a package on github.

IMPORTANT: In opening a pull request to FDBeye, you (a) affirm that you are the copyright owner for the material contained in the pull request, and (b) agree to apply the MIT license to the material contained in the pull request. Contributors retain copyright to their own code.

Other Researcher-Contributed Eye Tracking Tools

The list of (mostly FOSS) tools that used to be a part of this README file has been moved to the FDBeye Wiki.

davebraze/FDBeye documentation built on April 28, 2022, 1:20 a.m.