edf.recordings: Load Recordings

View source: R/edf_api.R

edf.recordingsR Documentation

Load Recordings

Description

Loads the recordings of a SR EyeLink EDFfile.

Usage

edf.recordings(EDFfile, fields)

Arguments

EDFfile

a character string giving the name of the EDFfile to load.

fields

a character string array giving the names of the fields to load.

Details

fields may be:

  • "time": start time or end time

  • "state": 0 = END, 1=START

  • "record_type": 1 = SAMPLES, 2= EVENTS, 3= SAMPLES and EVENTS

  • "pupil_type": 0 = AREA, 1 = DIAMETER

  • "recording_mode": 0 = PUPIL, 1 = CR

  • "filter_type": 1, 2, 3

  • "sample_rate": 250 or 500

  • "pos_type": 0 = GAZE, 1= HREF, 2 = RAW

  • "eye": 1=LEFT, 2=RIGHT, 3=LEFT and RIGHT

Specification of the field values are copied from the EDF Access C API user manual.

Value

a dataframe containing the specified fields of the recordings.

Author(s)

Guenther, T. and von der Malsburg, T.

Examples

## Not run: 
edf.recordings("example.EDF", c("time","state","record_type"))

edf.recordings(EDFfile="example.EDF", 
	fields=c("time","state","pupil_type","recording_mode","filter_type","eye"))

## End(Not run)

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