Skip to contents

Extract saccades from recorded events

Source: R/extract_saccades.R
extract_saccades.Rd

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).

Usage

extract_saccades(object)

# S3 method for class 'data.frame'
extract_saccades(object)

# S3 method for class 'eyelinkRecording'
extract_saccades(object)

Arguments

object

Either an eyelinkRecording object or data.frame with events, i.e., events slot of the eyelinkRecording object.

Value

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.

See also

read_edf, eyelinkRecording

Examples

data(gaze)

# by passing the recording
gaze <- extract_saccades(gaze)

# by passing events table
saccades <- extract_saccades(gaze$events)