load_asc {eyeris} | R Documentation |
Load and parse SR Research EyeLink .asc
files
Description
This function builds upon the eyelinker::read.asc()
function to parse the
messages and metadata within the EyeLink .asc
file. After loading and
additional processing, this function returns an S3 eyeris
class for use in
all subsequent eyeris
pipeline steps and functions.
Usage
load_asc(
file,
block = "auto",
binocular_mode = c("average", "left", "right", "both")
)
Arguments
file |
An SR Research EyeLink |
block |
Optional block number specification. The following are valid options:
|
binocular_mode |
Optional binocular mode specification. The following are valid options:
|
Details
This function is automatically called by glassbox()
by default. If
needed, customize the parameters for load_asc
by providing a parameter
list.
Users should prefer using glassbox()
rather than invoking this
function directly unless they have a specific reason to customize the
pipeline manually.
Value
An object of S3 class eyeris
with the following attributes:
-
file
: Path to the original.asc
file. -
timeseries
: Data frame of all raw time series data from the tracker. -
events
: Data frame of all event messages and their time stamps. -
blinks
: Data frame of all blink events. -
info
: Data frame of various metadata parsed from the file header. -
latest
:eyeris
variable for tracking pipeline run history.
For binocular data with binocular_mode = "both"
, returns a list
containing:
-
left
: Aneyeris
object for the left eye data. -
right
: Aneyeris
object for the right eye data. -
original_file
: Path to the original.asc
file.
Note
This function is part of the glassbox()
preprocessing pipeline and is not
intended for direct use in most cases. Provide parameters via
load_asc = list(...)
.
Advanced users may call it directly if needed.
See Also
eyelinker::read.asc()
which this function wraps.
glassbox()
for the recommended way to run this step
as part of the full eyeris glassbox preprocessing pipeline.
Examples
demo_data <- eyelink_asc_demo_dataset()
demo_data |>
eyeris::glassbox(load_asc = list(block = 1))
# Other useful parameter configurations
## (1) Basic usage (no block column specified)
demo_data |>
eyeris::load_asc()
## (2) Manual specification of block number
demo_data |>
eyeris::load_asc(block = 3)
## (3) Auto-detect multiple recording segments embedded within the same
## file (i.e., the default behavior)
demo_data |>
eyeris::load_asc(block = "auto")
## (4) Omit block column
demo_data |>
eyeris::load_asc(block = NULL)