| Title: | Import Gaze Data for EyeLink Eye Tracker |
|---|---|
| Description: | Import gaze data from edf files generated by the SR Research <https://www.sr-research.com/> EyeLink eye tracker. Gaze data, both recorded events and samples, is imported per trial. The package allows to extract events of interest, such as saccades, blinks, etc. as well as recorded variables and custom events (areas of interest, triggers) into separate tables. The package requires EDF API library that can be obtained at <https://www.sr-research.com/support/>. |
| Authors: | Alexander Pastukhov [aut, cre]
|
| Maintainer: | Alexander Pastukhov <[email protected]> |
| License: | GPL (>= 3) |
| Version: | 1.0.2 |
| Built: | 2024-12-08 07:18:46 UTC |
| Source: | CRAN |
Uses text in the message to adjust its time. E.g.,
for a message "-50 TARGET_ONSET" that was sent at 105600
the actual onset occurred 50 milliseconds earlier (-50). The function
adjusts the event timing and removes the timing offset information from
the message. I.e., the example message becomes "TARGET_ONSET" and
its time become 105550.
adjust_message_time(object, prefix) ## S3 method for class 'data.frame' adjust_message_time(object, prefix = "^[-+]?[:digit:]+[:space:]+") ## S3 method for class 'eyelinkRecording' adjust_message_time(object, prefix = "^[-+]?[:digit:]+[:space:]+")adjust_message_time(object, prefix) ## S3 method for class 'data.frame' adjust_message_time(object, prefix = "^[-+]?[:digit:]+[:space:]+") ## S3 method for class 'eyelinkRecording' adjust_message_time(object, prefix = "^[-+]?[:digit:]+[:space:]+")
object |
An |
prefix |
String with a regular expression that defines the offset.
Defaults to |
Object of the same time as input, i.e., either a eyelinkRecording object
with modified events slot or a data.frame with offset-adjusted events.
data(gaze) # by passing events table adjusted_events <- adjust_message_time(gaze$events) # by passing the recording gaze <- adjust_message_time(gaze)data(gaze) # by passing events table adjusted_events <- adjust_message_time(gaze$events) # by passing the recording gaze <- adjust_message_time(gaze)
Return status of compiled library
compiled_library_status()compiled_library_status()
logical
compiled_library_status()compiled_library_status()
Computes cyclopean samples by averaging over binocular recorded properties
such as pxL/pxR, pyL/pyR, hxL/hxR,
etc. Uses function specified via fun
parameter to compute the average with na.rm = TRUE option.
In case of a monocular recording or when the information from one eye missing,
uses information from one eye only, ignoring the other column.
In both binocular and monocular recording cases, simplifies column names
so that pxL and/or pxR are replaced
with a single column px, pyL/pyR with py, etc.
compute_cyclopean_samples(object, fun = mean) ## S3 method for class 'data.frame' compute_cyclopean_samples(object, fun = mean) ## S3 method for class 'eyelinkRecording' compute_cyclopean_samples(object, fun = mean)compute_cyclopean_samples(object, fun = mean) ## S3 method for class 'data.frame' compute_cyclopean_samples(object, fun = mean) ## S3 method for class 'eyelinkRecording' compute_cyclopean_samples(object, fun = mean)
object |
Either an |
fun |
Function used to average across eyes, defaults to |
Object of the same time as input, i.e., either a eyelinkRecording object
with modified samples slot or a data.frame with cyclopean samples.
data(gaze) # by passing samples table cyclopean_samples <- compute_cyclopean_samples(gaze$samples) # storing cyclopean samples as a separate table in recording gaze$cyclopean_samples <- compute_cyclopean_samples(gaze$samples) # by passing the recording, cyclopean samples replace original ones gaze <- compute_cyclopean_samples(gaze)data(gaze) # by passing samples table cyclopean_samples <- compute_cyclopean_samples(gaze$samples) # storing cyclopean samples as a separate table in recording gaze$cyclopean_samples <- compute_cyclopean_samples(gaze$samples) # by passing the recording, cyclopean samples replace original ones gaze <- compute_cyclopean_samples(gaze)
Converts all -32767 (smallest INT16 value indicating missing info) to NA.
You don't need to call this function directly, as it is automatically evoked within
read_edf function.
convert_NAs(original_frame)convert_NAs(original_frame)
original_frame |
data.frame to be processed |
processed data.frame
data(gaze) gaze$samples <- convert_NAs(gaze$samples)data(gaze) gaze$samples <- convert_NAs(gaze$samples)
Extracts rectangular areas of interest (AOI),
as defined by "!V IAREA RECTANGLE" command.
Specifically, we expect it to be in format
!V IAREA RECTANGLE <index> <left> <top> <right> <bottom> <label>,
where <label> is a string label and all other variables are integer.
Please note that due to a non-standard nature of this function is not called
during the read_edf call and you need to call it separately.
extract_AOIs(object) ## S3 method for class 'data.frame' extract_AOIs(object) ## S3 method for class 'eyelinkRecording' extract_AOIs(object)extract_AOIs(object) ## S3 method for class 'data.frame' extract_AOIs(object) ## S3 method for class 'eyelinkRecording' extract_AOIs(object)
object |
Either an |
Object of the same time as input, i.e., either a eyelinkRecording object
with an additional AOIs slot or a data.frame with AOIs' information. See
eyelinkRecording for details.
data(gaze) # by passing the recording gaze <- extract_AOIs(gaze) # by passing events table AOIs <- extract_AOIs(gaze$events)data(gaze) # by passing the recording gaze <- extract_AOIs(gaze) # by passing events table AOIs <- extract_AOIs(gaze$events)
Extracts blinks from the events table of the eyelinkRecording object.. Normally,
you don't need to call this function yourself,
as it is called during the read_edf with default settings
(e.g., import_blinks = TRUE).
extract_blinks(object) ## S3 method for class 'data.frame' extract_blinks(object) ## S3 method for class 'eyelinkRecording' extract_blinks(object)extract_blinks(object) ## S3 method for class 'data.frame' extract_blinks(object) ## S3 method for class 'eyelinkRecording' extract_blinks(object)
object |
Either an |
Object of the same time as input, i.e., either a eyelinkRecording object
with an additional blinks slot or a data.frame with blinks' information. See
eyelinkRecording for details.
read_edf, eyelinkRecording
data(gaze) # by passing the recording gaze <- extract_blinks(gaze) # by passing events table blinks <- extract_blinks(gaze$events)data(gaze) # by passing the recording gaze <- extract_blinks(gaze) # by passing events table blinks <- extract_blinks(gaze$events)
Extracts display coordinates from a message that adheres to a
<message_prefix> <label> format. Please note that this function called
during the read_edf call with silent = TRUE. If display_coords
are missing from the eyelinkRecording, run this method to see the warnings.
extract_display_coords( object, message_prefix = "DISPLAY_COORDS", silent = FALSE ) ## S3 method for class 'data.frame' extract_display_coords( object, message_prefix = "DISPLAY_COORDS", silent = FALSE ) ## S3 method for class 'eyelinkRecording' extract_display_coords( object, message_prefix = "DISPLAY_COORDS", silent = FALSE )extract_display_coords( object, message_prefix = "DISPLAY_COORDS", silent = FALSE ) ## S3 method for class 'data.frame' extract_display_coords( object, message_prefix = "DISPLAY_COORDS", silent = FALSE ) ## S3 method for class 'eyelinkRecording' extract_display_coords( object, message_prefix = "DISPLAY_COORDS", silent = FALSE )
object |
Either an |
message_prefix |
Beginning of the message string that identifies the DISPLAY_COORDS message.
Defaults to |
silent |
Whether to suppress a warning when DISPLAY_COORDS message is missing. Default to |
A eyelinkRecording object with an additional display_coords slot (if that was object type),
Either a four element numeric vector with display coordinates, or NULL if object was an events table of
eyelinkRecording object. See eyelinkRecording for details.
read_edf, eyelinkRecording
data(gaze) # by passing the recording gaze <- extract_display_coords(gaze) # by passing events table display_coords <- extract_display_coords(gaze$events)data(gaze) # by passing the recording gaze <- extract_display_coords(gaze) # by passing events table display_coords <- extract_display_coords(gaze$events)
Extracts fixations from the events table of the eyelinkRecording object.
Normally, you don't need to call this function yourself,
as it is called during the read_edf with default settings
(e.g., import_fixations = TRUE).
extract_fixations(object) ## S3 method for class 'data.frame' extract_fixations(object) ## S3 method for class 'eyelinkRecording' extract_fixations(object)extract_fixations(object) ## S3 method for class 'data.frame' extract_fixations(object) ## S3 method for class 'eyelinkRecording' extract_fixations(object)
object |
Either an |
Object of the same time as input, i.e., either a eyelinkRecording object
with an additional fixations slot or a data.frame with fixations' information. See
eyelinkRecording for details.
read_edf, eyelinkRecording
data(gaze) # by passing the recording gaze <- extract_fixations(gaze) # by passing events table fixations <- extract_fixations(gaze$events)data(gaze) # by passing the recording gaze <- extract_fixations(gaze) # by passing events table fixations <- extract_fixations(gaze$events)
Extract saccades from the events table of the eyelinkRecording object.
Normally, you don't need to call this function yourself,
as it is called during the read_edf with default
settings (e.g., import_saccades = TRUE).
extract_saccades(object) ## S3 method for class 'data.frame' extract_saccades(object) ## S3 method for class 'eyelinkRecording' extract_saccades(object)extract_saccades(object) ## S3 method for class 'data.frame' extract_saccades(object) ## S3 method for class 'eyelinkRecording' extract_saccades(object)
object |
Either an |
Object of the same time as input, i.e., either a eyelinkRecording object
with an additional saccades slot or a data.frame with saccades' information. See
eyelinkRecording for details.
read_edf, eyelinkRecording
data(gaze) # by passing the recording gaze <- extract_saccades(gaze) # by passing events table saccades <- extract_saccades(gaze$events)data(gaze) # by passing the recording gaze <- extract_saccades(gaze) # by passing events table saccades <- extract_saccades(gaze$events)
Extracts trigger events, messages that adhere to a
<message_prefix> <label> format. Their purpose is to identify the time
instance of specific interest.
Please note that due to a non-standard nature of this function is not called
during the read_edf call and you need to call it separately.
extract_triggers(object, message_prefix = "TRIGGER") ## S3 method for class 'data.frame' extract_triggers(object, message_prefix = "TRIGGER") ## S3 method for class 'eyelinkRecording' extract_triggers(object, message_prefix = "TRIGGER")extract_triggers(object, message_prefix = "TRIGGER") ## S3 method for class 'data.frame' extract_triggers(object, message_prefix = "TRIGGER") ## S3 method for class 'eyelinkRecording' extract_triggers(object, message_prefix = "TRIGGER")
object |
Either an |
message_prefix |
Beginning of the message string that identifies trigger messages.
Defaults to |
Object of the same time as input, i.e., either a eyelinkRecording object
with an additional triggers slot or a data.frame with triggers' information. See
eyelinkRecording for details.
read_edf, eyelinkRecording
data(gaze) # by passing the recording gaze <- extract_triggers(gaze) # by passing events table triggers <- extract_triggers(gaze$events) # with an explicit message prefix triggers <- extract_triggers(gaze$events, "TRIGGER")data(gaze) # by passing the recording gaze <- extract_triggers(gaze) # by passing events table triggers <- extract_triggers(gaze$events) # with an explicit message prefix triggers <- extract_triggers(gaze$events, "TRIGGER")
Extracts variables from the events table of the eyelinkRecording object.
Normally, you don't need to call this function yourself,
as it is called during the read_edf with default settings
(e.g., import_variables = TRUE).
extract_variables(object) ## S3 method for class 'data.frame' extract_variables(object) ## S3 method for class 'eyelinkRecording' extract_variables(object)extract_variables(object) ## S3 method for class 'data.frame' extract_variables(object) ## S3 method for class 'eyelinkRecording' extract_variables(object)
object |
Either an |
Object of the same time as input, i.e., either a eyelinkRecording object
with an additional variables slot or a data.frame with variables' information. See
eyelinkRecording for details.
read_edf, eyelinkRecording
data(gaze) # by passing the recording gaze <- extract_variables(gaze) # by passing events table variables <- extract_variables(gaze$events)data(gaze) # by passing the recording gaze <- extract_variables(gaze) # by passing events table variables <- extract_variables(gaze$events)
Imports gaze data recorded by a SR Research EyeLink eye tracker from an EDF file. Includes options to import events and/or recorded samples and extract individual events such as saccades, fixations, blinks, and recorded variables.
Maintainer: Alexander Pastukhov [email protected] (ORCID)
Useful links:
Report bugs at https://github.com/alexander-pastukhov/eyelinkReader/issues
eyelinkRecording.S3 class containing information imported from an edf-file.
See methods(class = "eyelinkRecording") for an overview of available methods.
preambleA preamble of the recording, see also read_preamble.
eventsEvents table which is a collection of all FEVENT imported from the EDF file. See description below.
samplesSamples table which is a collection of all FSAMPLE imported from the EDF file. See description below.
headersHeaders of the individual trials, see description below.
recordingsIndividual recording start/end information, see description below.
display_coordsRecorded screen coordinates (if recorded), see extract_display_coords.
saccadesSaccades extracted from events, see description below and extract_saccades.
fixationsFixations extracted from events, see description below and extract_fixations.
blinksBlinks extracted from events, see description below and extract_blinks.
variablesRecorded variables extracted from events, see description below and extract_variables.
triggersEvents messages that adhere to a TRIGGER <label> format.
This is a non-standard message that the package author uses to mark events like onsets or offsets,
similar to how it is done in M/EEG. See description below and extract_triggers.
AOIsAreas of interest events. See description below and extract_AOIs.
Events table which is a collection of all FEVENT imported from the EDF file.
Column descriptions were copied directly from the EDF access C API manual.
Please refer to that manual for further details. Additional non-standard fields are marked in bold.
trial Trial index, starts at 1.
time Time of event.
type Event type.
read Flags which items were included.
sttime Start time of the event.
entime End time of the event.
sttime_rel Start time of the event, relative to the start time of the trial.
entime_rel End time of the event, relative to the start time of the trial.
hstx, hsty Head reference starting points.
gstx, gsty Gaze starting points.
sta Pupil size at start.
henx, heny Headref ending points.
genx, geny Gaze ending points.
ena Pupil size at end.
havx, havy Headref averages.
gavx, gavy Gaze averages.
ava Average pupil size.
avel Accumulated average velocity.
pvel Accumulated peak velocity.
svel Start velocity.
evel End velocity.
supd_x, supd_y Start units-per-degree.
eupd_x, eupd_y End units-per-degree.
eye Either 'LEFT' (0) or 'RIGHT' (1).
status Error, warning flags.
flags Flags to indicate contents.
input Extra (input word).
buttons Button state and changes.
parsedby 7 bits of flags, PARSEDBY codes.
message Any message string.
Samples table which is a collection of all FSAMPLE imported from the EDF file.
Please note that read_edf parameters determines which fields are imported.
Column descriptions were copied directly from the EDF access C API manual.
Please refer to that manual for further details. Suffixes L and R denote left and right eye.
Non-standard additional fields are marked in bold.
trial Trial index, starts at 1.
eye 'LEFT' (0), 'RIGHT' (1), or 'BINOCULAR' (2).
time Time of sample.
time_rel Time relative to the start of the trial.
pxL, pxR, pyL, pyR Pupil coordinates.
hxL, hxR, hyL, hyR Headref coordinates.
paL, paR Pupil size or area.
gxL, gxR, gyL, gyR Screen gaze coordinates.
rx, ry Screen pixels per degree.
gxvelL, gxvelR, gyvelL, gyvelR Gaze velocity.
hxvelL, hxvelR, hyvelL, hyvelR Headref velocity.
rxvelL, rxvelR, ryvelL, ryvelR Raw velocity.
fgxvelL, fgxvelR, fgyvelL, fgyvelR Fast gaze velocity.
fhxvelL, fhxvelR, fhyvelL, fhyvelR Fast headref velocity.
frxvelL, frxvelR, fryvelL, fryvelR Fast raw velocity.
hdata_1 -hdata_8 Head-tracker data (not pre-scaled). Each column correspond to a single element of the INT16 FSAMPLE::hdata[8].
flags Flags to indicate contents.
input Extra (input word).
buttons Button state & changes.
htype Head-tracker data type (0=none).
errors Process error flags.
Trial headers table which is a collection of all TRIAL structures imported from the EDF file.
Column descriptions were copied directly from the EDF access C API manual.
Please refer to that manual for further details.
All fields of the RECORDINGS structure are prefixed with rec_.
Non-standard additional fields are marked in bold.
trial Trial index.
duration Duration of the trial.
starttime Start time of the trial.
endtime End time of the trial.
rec_time Start time or end time.
rec_sample rate Sample rate in Hz: 250, 500, 1000 or 2000.
rec_eflags Extra information about events.
rec_sflags Extra information about samples.
rec_state 'START' (2) or 'END' (1).
rec_record_type 'SAMPLES' (1), 'EVENTS' (2), or 'SAMPLES and EVENTS' (3).
rec_pupil_type 'AREA' (0) or 'DIAMETER' (1).
rec_recording_mode 'PUPIL' (0) or 'CR' (1).
rec_filter_type 1, 2, or 3.
rec_pos_type Should be 'GAZE' (0), 'HREF' (1) or 'RAW', but currently this column is kept as numeric, since observed values do not match the declared constants.
rec_eye 'LEFT' (1), 'RIGHT' (2) or 'LEFT and RIGHT' (3).
Recordings table which is a collection of all RECORDING structures imported from the EDF file.
Column descriptions were copied directly from the EDF access C API manual.
Please refer to that manual for further details. Non-standard additional fields are marked in bold.
trial Trial index.
time Start time or end time.
sample rate Sample rate in Hz: 250, 500, 1000 or 2000.
eflags Extra information about events.
sflags Extra information about samples.
state 'START' (2) or 'END' (1).
record_type 'SAMPLES' (1), 'EVENTS' (2), or 'SAMPLES and EVENTS' (3).
pupil_type 'AREA' (0) or 'DIAMETER' (1).
recording_mode 'PUPIL' (0) or 'CR' (1).
filter_type 1, 2, or 3.
pos_type Should be 'GAZE' (0), 'HREF' (1) or 'RAW', but currently this column is kept as numeric, since observed values do not match the declared constants.
eye 'LEFT' (1), 'RIGHT' (2) or 'LEFT and RIGHT' (3).
Saccades and fixations extracted from the events, tables have the same structure.
Column descriptions were copied directly from the EDF access C API manual.
Please refer to that manual for further details. Non-standard additional fields are marked in bold.
trial Trial index.
sttime Start time.
entime End time.
sttime_rel Start time, relative to the start time of the trial.
entime_rel End time, relative to the start time of the trial.
duration Duration.
hstx, hsty Head reference starting points.
gstx, gsty Gaze starting points.
sta Pupil size at start.
henx, heny Headref ending points.
genx, geny Gaze ending points.
ena Pupil size at end.
havx, havy Headref averages.
gavx, gavy Gaze averages.
ava Average pupil size.
avel Accumulated average velocity.
pvel Accumulated peak velocity.
svel Start velocity.
evel End velocity.
supd_x, supd_y Start units-per-degree.
eupd_x, eupd_y End units-per-degree.
eye Either 'LEFT' (1) or 'RIGHT' (2).
Blinks extracted from the events table. Column descriptions were copied directly from the EDF access C API manual.
Please refer to that manual for further details. Non-standard additional fields are marked in bold.
trial Trial index.
sttime Start time.
entime End time.
sttime_rel Start time, relative to the start time of the trial.
entime_rel End time, relative to the start time of the trial.
duration Duration.
eye Either 'LEFT' (1) or 'RIGHT' (2).
User recorded variables extracted from message events with a 'TRIAL_VAR' prefix.
Original format can be either 'TRIAL_VAR <name> <value>' or 'TRIAL_VAR <name>=<value>'.
The <name> cannot contain spaces or '=' sign.
White spaces are trimmed for both <name> and <value>.
trial Trial index.
sttime Start time.
sttime_rel Start time, relative to the start time of the trial.
variable Variable name, the <name> part of the event message.
value Variable value, the <value> part of the event message.
Events messages that adhere to a TRIGGER <label> format.
This is a non-standard message that the package author uses to mark events like onsets or offsets,
similar to how it is done in M/EEG.
trial Trial index.
sttime Start time.
sttime_rel Start time, relative to the start time of the trial.
label label part of the message, can contain white spaces.
Rectangular areas of interest (AOI), as defined by "!V IAREA RECTANGLE" command.
Specifically, they are expected to be in format
!V IAREA RECTANGLE <index> <left> <top> <right> <bottom> <label>.
where <label> is a string label and all other variables are integer.
trial Trial index.
sttime Start time.
sttime_rel Start time, relative to the start time of the trial.
index AOI index.
left, top, right, bottom AOI coordinates.
label AOI label.
read_edf, extract_saccades, extract_fixations, extract_blinks, extract_triggers, extract_display_coords, extract_AOIs
An eyelinkRecording for example.edf via
read_edf(system.file("extdata", "example.edf", package = "eyelinkReader"), import_samples = TRUE)).
Contains all extracted events including triggers, areas of interested, and display coordinates. The original
recording consist of ten trials with a participant fixating on a target that jumps to a new location after
one second and stays on the screen for another second. Includes all relevant events.
gazegaze
An object of class eyelinkRecording of length 12.
See eyelinkRecording for details.
This is only a basic plotting utility intended primarily for a quick visual check. Please refer to companion vignette on plotting for details about geoms and implementing your own custom plotting routine.
## S3 method for class 'eyelinkRecording' plot( x, trial = 1, show_fixations = TRUE, fixation_size_property = "duration", size_legend = ifelse(fixation_size_property == "duration", "Fixation duration [ms]", NA), show_saccades = TRUE, saccade_color_property = "sttime_rel", color_legend = ifelse(saccade_color_property == "sttime_rel", "Saccade onset [ms]", NA), background_grobs = NULL, ... )## S3 method for class 'eyelinkRecording' plot( x, trial = 1, show_fixations = TRUE, fixation_size_property = "duration", size_legend = ifelse(fixation_size_property == "duration", "Fixation duration [ms]", NA), show_saccades = TRUE, saccade_color_property = "sttime_rel", color_legend = ifelse(saccade_color_property == "sttime_rel", "Saccade onset [ms]", NA), background_grobs = NULL, ... )
x |
|
trial |
Trials to be plotted, could be a scalar index,
a vector of indexes, or |
show_fixations |
logical, whether to draw fixation as circles. Defaults to |
fixation_size_property |
Which fixation property is used as circle aesthetics. Defaults to |
size_legend |
An optional legend title, defaults to |
show_saccades |
logical, whether to draw saccades as line segments. Defaults to |
saccade_color_property |
Which saccade property is used as color aesthetics. Defaults to |
color_legend |
An optional legend title, defaults to |
background_grobs |
ggplot2 graphic objects add to the plot before plotting data. |
... |
Addition parameters (unused) |
ggplot object
data(gaze) # fixations and saccades for the first trial plot(gaze) # fixations for the all trials plot(gaze, trial = NULL, show_saccades = FALSE) # saccades for the first two trials plot(gaze, trial = 1:2, show_fixations = FALSE) # color codes duration of a saccade plot(gaze, saccade_color_property = "duration")data(gaze) # fixations and saccades for the first trial plot(gaze) # fixations for the all trials plot(gaze, trial = NULL, show_saccades = FALSE) # saccades for the first two trials plot(gaze, trial = 1:2, show_fixations = FALSE) # color codes duration of a saccade plot(gaze, saccade_color_property = "duration")
eyelinkRecording
Print info about eyelinkRecording
## S3 method for class 'eyelinkRecording' print(x, ...)## S3 method for class 'eyelinkRecording' print(x, ...)
x |
|
... |
Addition parameters (unused) |
No return value, called for printing to console.
if (eyelinkReader::compiled_library_status()) { recording <- read_edf(system.file("extdata", "example.edf", package = "eyelinkReader")) print(recording) }if (eyelinkReader::compiled_library_status()) { recording <- read_edf(system.file("extdata", "example.edf", package = "eyelinkReader")) print(recording) }
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.
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 )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 )
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
|
import_recordings |
logical, whether to import information about start/end of the recording, defaults to
|
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 ( |
an eyelinkRecording object that contains events, samples,
and recordings, as well as specific events such as saccades, fixations, blinks, etc.
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) }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) }
Read the preamble of the EDF file and parses it into an reading-friendly format
read_preamble(file, fail_loudly = TRUE)read_preamble(file, fail_loudly = TRUE)
file |
name of the EDF file |
fail_loudly |
logical, whether lack of compiled library means
error ( |
a character vector but with added class eyelinkPreamble to simplify printing.
if (eyelinkReader::compiled_library_status()) { read_preamble(system.file("extdata", "example.edf", package = "eyelinkReader")) }if (eyelinkReader::compiled_library_status()) { read_preamble(system.file("extdata", "example.edf", package = "eyelinkReader")) }