VWPre (version 1.2.4)

fasttrack: Fast-track basic preprocessing

Description

fasttrack is a meta-function for advanced users who are already familiar with the package functions and do not need to take remedial actions such as recoding interest areas, remapping gaze data, or performing message alignment.It takes all necessary arguments for the component functions to produce proportion looks and can output either empirical logits or binomial data. The function returns a dataframe containing the result of the series of subroutines.

Usage

fasttrack(
  data = data,
  Subject = NULL,
  Item = NA,
  EventColumns = c("Subject", "TRIAL_INDEX"),
  NoIA = NoIA,
  Adjust = 0,
  Recording = NULL,
  WhenLandR = NA,
  BinSize = NULL,
  SamplingRate = NULL,
  ObsPerBin = NULL,
  ObsOverride = FALSE,
  Constant = 0.5,
  CustomBinom = NULL,
  Output = NULL
)

Arguments

data

A data frame object created from an Eyelink Sample Report.

Subject

An obligatory string containing the column name corresponding to the subject identifier.

Item

An optional string containing the column name corresponding to the item identifier; by default, NA.

EventColumns

A vector specifying the columns which will be used for creating the Event variable; by default, Subject and TRIAL_INDEX.

NoIA

A positive integer indicating the number of interest areas defined when creating the study.

Adjust

An integer indicating amount of time in milliseconds by which to offset the time series.

Recording

A string indicating which eyes were used for recording gaze data.

WhenLandR

A string indicating which eye ("Right" or "Left) to use if gaze data is available for both eyes (i.e., Recording = "LandR").

BinSize

A positive integer indicating the size of the binning window (in milliseconds).

SamplingRate

A positive integer indicating the sampling rate (in Hertz) used to record the gaze data.

ObsPerBin

A positive integer indicating the desired number of observations to be used in the calculations.

ObsOverride

A logical value controlling restrictions on the value provided to ObsPerBin. Default value is FALSE.

Constant

A positive number used for the empirical logit and weights calculation; by default, 0.5 as in Barr (2008).

CustomBinom

An optional parameter specifying a vector containing two integers corresponding to the interest area IDs to be combined.

Output

An obligatory string containing either "ELogit" or "Binomial".

Value

A data table containing formatting and calculations.

Examples

# NOT RUN {
library(VWPre)
# Perform meta-function on data
df <- fasttrack(data = dat, Subject = "RECORDING_SESSION_LABEL", Item = "itemid", 
       EventColumns = c("Subject", "TRIAL_INDEX"), NoIA = 4, Adjust = 100, 
			Recording = "LandR", WhenLandR = "Right", BinSize = 20, 
			SamplingRate = 1000, ObsPerBin = 20, Constant = 0.5, 
			Output = "ELogit")
# }