R/RcppExports.R

In eyelinkReader: Import Gaze Data for EyeLink Eye Tracker

# Generated by using Rcpp::compileAttributes() -> do not edit by hand
# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393

#' @title Status of compiled library
#' @description Return status of compiled library
#' @return logical
#' @export
#' @examples
#' compiled_library_status()
compiled_library_status <- function() {
    .Call('_eyelinkReader_compiled_library_status', PACKAGE = 'eyelinkReader')
}

#' @title Convert -32767 (missing info) to NA
#' @description Converts all -32767 (smallest INT16  value indicating missing info) to NA.
#' You don't need to call this function directly, as it is automatically evoked within
#' \code{\link{read_edf}} function.
#' @param original_frame data.frame to be processed
#' @return processed data.frame
#' @export
#' @examples
#' \donttest{
#'   data(gaze)
#'   gaze$samples <- convert_NAs(gaze$samples)
#' }
convert_NAs <- function(original_frame) {
    .Call('_eyelinkReader_convert_NAs', PACKAGE = 'eyelinkReader', original_frame)
}

#' @title Internal function that reads EDF file
#' @description Reads EDF file into a list that contains events, samples, and recordings.
#' DO NOT call this function directly. Instead, use read_edf function that implements
#' parameter checks and additional postprocessing.
#' @param filename full name of the EDF file
#' @param consistency consistency check control (for the time stamps of the start
#' and end events, etc). 0, no consistency check. 1, check consistency and report.
#' 2, check consistency and fix.
#' @param import_events load/skip loading events.
#' @param import_recordings load/skip loading recordings.
#' @param import_samples load/skip loading of samples.
#' @param sample_attr_flag boolean vector that indicates which sample fields are to be stored
#' @param start_marker_string event that marks trial start. Defaults to "TRIALID", if empty.
#' @param end_marker_string event that marks trial end
#' @param verbose whether to show progressbar and report number of trials
#' @export
#' @keywords internal
#' @return contents of the EDF file. Please see read_edf for details.
read_edf_file <- function(filename, consistency, import_events, import_recordings, import_samples, sample_attr_flag, start_marker_string, end_marker_string, verbose) {
    .Call('_eyelinkReader_read_edf_file', PACKAGE = 'eyelinkReader', filename, consistency, import_events, import_recordings, import_samples, sample_attr_flag, start_marker_string, end_marker_string, verbose)
}

#' @title Reads preamble of the EDF file as a single string.
#' @description Reads preamble of the EDF file as a single string.
#' Please, do not use this function directly. Instead, call \code{\link{read_preamble}} function
#' that provides a more consistent interface.
#' @return string with the preamble
#' @export
#' @keywords internal
#' @examples
#' \donttest{
#' if (eyelinkReader::compiled_library_status()) {
#'   read_preamble(system.file("extdata", "example.edf", package = "eyelinkReader"))
#' }
#' }
read_preamble_str <- function(filename) {
    .Call('_eyelinkReader_read_preamble_str', PACKAGE = 'eyelinkReader', filename)
}