pymovements.dataset.DatasetPaths.__init__#

DatasetPaths.__init__(*, root: str | Path = 'data', dataset: str | None = None, raw: str = 'raw', events: str = 'events', preprocessed: str = 'preprocessed', downloads: str = 'downloads')[source]#

Initialize a set of dataset paths.

Parameters:

  • root (str, Path) – Path to the root directory of the dataset.

  • dataset (str, optional) – Dataset directory name under root path. Can be . if dataset is located in root path. Default: .

  • str (raw ;) – Name of directory under dataset path that contains raw data. Can be . if raw data is located in dataset path. We advise the user to keep the original raw data separate from the preprocessed / event data. Default: raw

  • optional – Name of directory under dataset path that contains raw data. Can be . if raw data is located in dataset path. We advise the user to keep the original raw data separate from the preprocessed / event data. Default: raw

  • preprocessed (str, optional) – Name of directory under dataset path that will be used to store preprocessed data. We advise the user to keep the preprocessed data separate from the original raw data. Default: preprocessed

  • events (str, optional) – Name of directory under dataset path that will be used to store event data. We advise the user to keep the event data separate from the original raw data. Default: events

  • downloads (str, optional) – Name of directory to store downloaded data.Default: downloads