get_example_data#

pypillometry.get_example_data(key, cache_dir=None)[source]#

Load example data for a given example (see example_datasets).

Parameters:
  • key (str) – Key of the example dataset. Available keys are in the dictionary example_datasets.

  • cache_dir (str, optional) – directory to store downloaded files in (reused in later calls); default $XDG_CACHE_HOME/pypillometry (~/.cache/pypillometry). Ignored for datasets included in the package.

Return type:

EyeData

Returns:

The example dataset.