read_preamble {eyelinkReader}

Reads edf-file preamble

Description

Read the preamble of the EDF file and parses it into an reading-friendly format

Usage

read_preamble(file, fail_loudly = TRUE)

Arguments

file

name of the EDF file

fail_loudly

logical, whether lack of compiled library means error (TRUE, default) or just warning (FALSE).

Value

a character vector but with added class eyelinkPreamble to simplify printing.

Examples

 if (eyelinkReader::compiled_library_status()) {
  read_preamble(system.file("extdata", "example.edf", package = "eyelinkReader"))
}