edf.all: Load all data from EDF file

View source: R/edf_api.R

edf.allR Documentation

Load all data from EDF file

Description

edf.all returns all of the most common information from an SR-Research EyeLink EDF file (fixations, saccades, blinks, and samples)

Usage

edf.all(EDFfile, samples = FALSE, eventmask = FALSE)

Arguments

EDFfile

path to an EDF file

samples

logical indicating whether to import samples (default=FALSE)

eventmask

logical indicating whether to add an eventmask to samples (default=FALSE)

Details

edf.all is useful for obtaining fixations, saccades, blinks, and (optionally) samples from an EDF in one shot. If you need only 1 of these (i.e., just fixations) then use edf.events, edf.samples, edf.messages, or edf.recordings. By default it grabs only event data. Use the samples argument to get sample data as well.

Value

The output will be a list with 4 named elements (fixations, saccades, blinks, and samples) each element being a data frame

Author(s)

Jason Hubbard, hubbard3@uoregon.edu

Examples

## Not run: 
output <- edf.all('/path/to/file.edf',samples=TRUE)
output$fixations #data frame
output$saccades #another data frame


## End(Not run)

jashubbard/edfR documentation built on Aug. 4, 2022, 5:18 p.m.