ep.eye_default_options: Get Default Eye-Tracking Processing Options

In PennStateDEPENdLab/experiment_pipeline: Generates data markdown for NeuroMap Task

Get Default Eye-Tracking Processing Options

Description

Returns a hierarchical list containing the default options for the eye-tracking data processing pipeline.

Usage

ep.eye_default_options(edf_raw)

Value

A named list with default options for the following fields:

• global: General processing options, including:

  • base_dir (character): The base directory, defaults to the current working directory.

  • prefix (character): A regular expression pattern for the file prefix, defaults to "\d2,3".

  • save_steps (logical): Flag to save intermediate processing steps, defaults to TRUE.

  • preproc_out (character): Directory for preprocessed output, defaults to "preproc_out" in the current working directory.

  • log (logical): Flag to enable logging, defaults to FALSE.

  • remove_raw (logical): Flag to return raw data, defaults to FALSE.

• initialize: Initialization options, including:

  • expected_edf_fields (character vector): Expected EDF file fields, defaults to c("raw", "sacc", "fix", "blinks", "msg", "input", "button", "info", "asc_file").

  • unify_gaze_events (list): Gaze event unification options, defaults to:

    • gaze_events (character vector): Gaze events to unify, defaults to c("sacc", "fix", "blink").

    • confirm_correspondence (logical): Flag to confirm correspondence of gaze events, defaults to FALSE.

• msg_parse: Message parsing options, defaults to NULL.

• gaze_preproc: Gaze preprocessing options, including:

  • aoi (list): Area of interest (AOI) options, defaults to:

    • indicator (character): Indicator for AOI, defaults to "!V IAREA RECTANGLE".

    • extraction_method (character): Method for AOI extraction, defaults to "regex".

    • extraction_coords (character): Regular expression for extracting coordinates, defaults to "\d3,4 \d3,4 \d3,4 \d3,4".

    • extract_labs (character): Regular expression for extracting labels, defaults to "[a-z]+$".

    • split_coords (character): Character used to split coordinates, defaults to a single space.

    • tag_raw (logical): Flag to tag raw data, defaults to FALSE.

  • downsample (list): Downsampling options, defaults to:

    • downsampled_freq (numeric): Frequency to downsample to, defaults to 50 Hz.

    • method (character): Method for downsampling, defaults to "mean".

• pupil_preproc: Pupil preprocessing options, including:

  • blink_corr (list): Blink correction options, defaults to:

    • ms_before (numeric): Time before blink in milliseconds, defaults to 150.

    • ms_after (numeric): Time after blink in milliseconds, defaults to 150.

  • filter (list): Filtering options, defaults to:

    • method (character): Filtering method, defaults to "movingavg".

    • window_length (numeric): Length of the filtering window, defaults to 20.

  • interpolate (list): Interpolation options, defaults to:

    • algor (character): Interpolation algorithm, defaults to "linear".

    • maxgap (numeric): Maximum gap for interpolation in milliseconds, defaults to 1000.

  • baseline_correction (list): Baseline correction options, defaults to:

    • method (character): Method for baseline correction, defaults to "subtract".

    • dur_ms (numeric): Duration in milliseconds for baseline correction, defaults to 100.

    • center_on (character): Event to center baseline correction on, defaults to "DISPLAY_ON".

  • downsample (list): Downsampling options, defaults to:

    • downsampled_freq (numeric): Frequency to downsample to, defaults to 20 Hz.

    • method (character): Method for downsampling, defaults to "mean".

Author(s)

Nate Hall

Examples

defaults <- ep.eye_default_options()
str(defaults)

PennStateDEPENdLab/experiment_pipeline documentation built on Nov. 27, 2024, 4:56 a.m.