Reading and writing data

See Loading and saving data. Eyelink files are usually read with EyeData.from_eyelink(), saved objects with from_file().

Files and URLs

read_eyelink	Read an Eyelink file/URL and return the object returned by the "eyelinkio" package.
read_file	Read a Python object from a file using pickle (or HDF5).
write_file	Store any Python object in a file using pickle (or HDF5).
download	Download a file from a URL to a local file.
fetch_url	Download an HTTP(S) or SSH URL to a local file, with caching.
local_copy	Context manager that gives a local filename for source.

Studies and OSF

See Studies with many participants.

load_study_local	Read a study from a local directory (or an SSH URL) using the configuration file.
load_study_osf	Read a study from OSF using the configuration file.
get_osf_project_files	Get all file IDs from an OSF project.
osf_authenticate	Authenticate against the OSF API using a personal access token.

figshare

Files from public figshare items.

get_figshare_files	List the files of a public figshare item.
fetch_figshare_file	Download a file from a public figshare item, with caching.

Example datasets

get_available_datasets	Return available example datasets.
get_example_data	Load example data for a given example (see example_datasets).
get_rlmw_002	Load the "rlmw_002" example dataset (downloaded from OSF).
get_rlmw_002_short	Load the "rlmw_002_short" example dataset (included in the package).
get_rlmw_010_edf	Load the "rlmw_010_edf" example dataset (downloaded from OSF).
get_nback_001	Load the "nback_001" example dataset (downloaded from figshare).