read_edf {eyelinkReader} | R Documentation |
Read EDF file with gaze data recorded by SR Research EyeLink eye tracker
Description
Reads EDF file with gaze data recorded by SR Research EyeLink eye tracker
and returns an eyelinkRecording
object that contains events, samples,
and recordings, as well as specific events such as saccades, fixations, blinks, etc.
Usage
read_edf(
file,
consistency = "check consistency and report",
import_events = TRUE,
import_recordings = TRUE,
import_samples = FALSE,
sample_attributes = NULL,
start_marker = "TRIALID",
end_marker = "TRIAL_RESULT",
import_saccades = TRUE,
import_blinks = TRUE,
import_fixations = TRUE,
import_variables = TRUE,
verbose = TRUE,
fail_loudly = TRUE
)
Arguments
file |
full name of the EDF file |
consistency |
consistency check control for the time stamps of the start
and end events, etc. Could be |
import_events |
logical, whether to import events, defaults to codeTRUE |
import_recordings |
logical, whether to import information about start/end of the recording, defaults to codeTRUE |
import_samples |
logical, whether to import samples, defaults to |
sample_attributes |
a character vector that lists sample attributes to be imported.
By default, all attributes are imported (default). For the complete list of sample attributes
please refer to |
start_marker |
event string that marks the beginning of the trial. Defaults to |
end_marker |
event string that marks the end of the trial. Defaults to |
import_saccades |
logical, whether to extract saccade events into a separate table for convenience. Defaults to |
import_blinks |
logical, whether to extract blink events into a separate table for convenience. Defaults to |
import_fixations |
logical, whether to extract fixation events into a separate table for convenience. Defaults to |
import_variables |
logical, whether to extract stored variables into a separate table for convenience. Defaults to |
verbose |
logical, whether the number of trials and the progress are shown in the console. Defaults to |
fail_loudly |
logical, whether lack of compiled library means
error ( |
Value
an eyelinkRecording
object that contains events, samples,
and recordings, as well as specific events such as saccades, fixations, blinks, etc.
Examples
if (eyelinkReader::compiled_library_status()) {
# Import only events and recordings information
recording <- read_edf(system.file("extdata", "example.edf", package = "eyelinkReader"))
# Import events and samples (only time and screen gaze coordinates)
recording <- read_edf(system.file("extdata", "example.edf", package = "eyelinkReader"),
sample_attributes = c('time', 'gx', 'gy'))
# Import events and samples (all attributes)
recording <- read_edf(system.file("extdata", "example.edf", package = "eyelinkReader"),
import_samples= TRUE)
}