edf.samples: Load Samples

View source: R/edf_api.R

edf.samplesR Documentation

Load Samples

Description

Loads the samples of a SR EyeLink EDFfile.

Usage

edf.samples(EDFfile, fields, eventmask=FALSE, trials=FALSE)

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.

eventmask

logical indicating whether to add an eventmask to the samples

trials

logical indicating whether to include trial information (will add a variable called eyetrial

Details

fields may be:

  • "time": time stamp of sample

  • "flags": flags to indicate contents

  • "pxL": left pupil x

  • "pxR": right pupil x

  • "pyL": left pupil y

  • "pyR": right pupil y

  • "hxL", "hxR", "hyL", "hyR": headref x, y

  • "paL", "paR": pupil size or area

  • "gxL", "gxR", "gyL", "gyR": screen gaze x, y

  • "rx", "ry": screen pixels per degree

  • "status": tracker status flags

  • "errors": process error flags

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

Value

a dataframe containing the specified fields of the samples.

Author(s)

Guenther, T., Jason Hubbard, and von der Malsburg, T.

Examples

## Not run: 
edf.samples("example.EDF",
	c("time","gxL","gyL","paL","gxR","gyR","paR"))

edf.samples(EDFfile="example.EDF",
	fields=c("time","gxL","gyL","paL","gxR","gyR","paR"))

#imports trial information
edf.samples(EDFfile='example.EDF', trials=T)

## End(Not run)

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