R/edfR.R

In jashubbard/edfR: Basic functions for importing SR-Research Eyelink EDF files

#' edfR: Import from SR Eyelink EDF files
#'
#' @description
#' edfR allows one to import data from SR Research Eyelink EDF files. This includes
#' event-wise (fixations, saccades, blinks) as well as continuous samples (e.g., pupil diameter).
#' You MUST install the Eyelink Developer's Kit (edfapi) in order for this to work. You can download
#' from the SR-Research support forum (https://www.sr-support.com/forumdisplay.php?17-EyeLink-Display-Software)
#'
#' @section Functions:
#'
#' @section Basic Importing:
#' \itemize{
#' \item \code{\link{edf.events}} imports events (fixations by default, but any event can be specified).
#' \item \code{\link{edf.samples}} imports sample data including gaze location and pupil diameter
#' \item \code{\link{edf.messages}} imports messages, including those sent to Eyelink during an experiment
#' \item \code{\link{edf.recordings}} imports recording information.
#' }
#' @section Importing More Information:
#' \itemize{
#' \item \code{\link{edf.all}} imports events, messages, and (optionally) samples
#' \item \code{\link{edf.trials}} does the same as \code{edf.all} but in a trial-wise manner. Trials are determined
#' by the starting and stopping of the eye tracker during an experiment. It also adds an 'eyetrial' variable to
#' all events/samples to facilitate merging with behavioral data
#' }
#'
#' @section Utilities:
#' \itemize{
#' \item \code{\link{edf.batch}} batch import many edf files and save files for R or Matlab
#' \item \code{\link{combine.eyedata}} take the result of edf.batch and combine into data frames for entire group
#' \item \code{\link{edf.plot}} quickly create a fixation plot from an EDF file
#' \item \code{\link{epoch.samples}} take sample data and create epochs relative to a time-locking event
#' \item \code{\link{edf.trialcount}} quickly returns the number of trials in a named EDF file with little overhead
#' \item \code{\link{eventmask}} internal function. adds event-relevant binary variables to sample data.
#' }
#' @author Jason Hubbard, \email{hubbard3@@uoregon.edu}, Guenther, T. and von der Malsburg, T.
#'
#' @docType package
#' @name edfR
NULL
#> NULL