pymovements.datasets.toy_dataset.ToyDataset.__init__#

ToyDataset.__init__(root: str | Path, download: bool = False, extract: bool = False, remove_finished: bool = False, dataset_dirname: str = 'ToyDataset', downloads_dirname: str = 'downloads', raw_dirname: str = 'raw', preprocessed_dirname: str = 'preprocessed', events_dirname: str = 'events')[source]#

Initialize the pymovements example toy dataset object.

If desired, dataset resources are downloaded with download=True and extracted with extract=True. To save space on your device you can remove the archive files after successful extraction with remove_finished=True.

Downloaded archives are automatically checked for integrity by comparing MD5 checksums.

You can set up a custom directory structure by populating the particular dirname attributes. See dataset_dirname, raw_dirname, preprocessed_dirname and events_dirname and downloads_dirname for details.

Parameters:

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

  • download (bool) – Download all dataset resources.

  • extract (bool) – Extract dataset archive files.

  • remove_finished (bool) – Remove archive files after extraction.

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

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

  • str (raw_dirname ;) – 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_dirname (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_dirname (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