Function reference • pupilr

Object definitions Pupilr, surfaces object definitions
`PupilrObject()`	Pupilr object definition
`SurfaceItemObject()`	Creates surface.item object
`SurfacesObject()`	Creates surfaces object
`is.pupilr()`	Returns if the object has class pupilr
Loading functions to load pupil data
`load_folder()`	Loads all important exported objecs from given folder
`load_surface_data()`	Loads folder with surface data
`open_surfaces()`	Searches for the surfaces and tries to load them into a list
`open_exported_file()`	General function to load preprocessed file based on pattern
`open_expoted_info_file()`	Finds and loads `exported_info.csv` file from given directory
`open_fixations_file()`	Retusns fixations data.frame
`open_gaze_file()`	Retusns gaze positions data frame
`open_info_file()`	Finds and loads `info.csv` file from given directory
`open_positions_file()`	Returns data frame of pupil positions
`open_timestamps_file()`	Returns data frame of world_timestamps
`load_key_value_file()`	Function to read pupil key, value style dataframes into named list
Preprocessing
`change_timestamps_start()`	Changes timestamps to a given start time
`as.eyer()`	Converts given object to an eyer object
`remove_not_on_surface()`	Removes measurements which are not on given surface
`remove_not_on_surface(<surface>)`	Removes measurements which are not on given surface
Getters Functions to access parts of objects
`get_gaze()`	Returns gaze data.frame
`get_gaze_timewindow()`	Returns gaze data in a given timewindows
`filter_times()`	Filters out object with only times between start and end
`get_surface_names()`	Returns names of all surfaces in the object
`get_surface()`	Returns sufface of a given name
Visualisation Basic visualisation fuctions. For extendend functionality, use `eyer` package
`plot_gaze_data()`	Pot gaze data

Reference

Object definitions

Loading

Preprocessing

Getters

Visualisation