pymovements.dataset.Dataset.save_events#

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

Save events to files.

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

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)
verbose (int) – Verbosity level (0: no print output, 1: show progress bar, 2: print saved filepaths) (default: 1)
extension (str) – Specifies the file format for loading data. Valid options are: csv, feather. (default: ‘feather’)

Returns:

Returns self, useful for method cascading.

Return type:

Dataset

Raises:

ValueError – If extension is not in list of valid extensions.