pymovements.dataset.Dataset.save#

Dataset.save(events_dirname: str | None = None, preprocessed_dirname: str | None = None, verbose: int = 1, extension: str = 'feather') → Dataset#

Save preprocessed gaze and event files.

Data will be saved as feather/csv files to Dataset.preprocessed_roothpath or Dataset.events_roothpath with the same directory structure as the raw data.

Returns:

Returns self, useful for method cascading.

Return type:

Dataset

Parameters:

events_dirname (str | None) – One-time usage of an alternative directory name to save data relative to dataset path. This argument is used only for this single call and does not alter pymovements.Dataset.events_rootpath(). (default: None)
preprocessed_dirname (str | None) – One-time usage of an alternative directory name to save data relative to dataset path. This argument is used only for this single call and does not alter pymovements.Dataset.preprocessed_rootpath(). (default: None)
verbose (int) – Verbosity level (0: no print output, 1: show progress bar, 2: print saved filepaths) (default: 1)
extension (str) – Extension specifies the fileformat to store the data. (default: ‘feather’)