pymovements.dataset.DatasetPaths#

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

Defines the paths of a dataset.

__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

Methods

`__init__`(*[, root, dataset, raw, events, ...])	Initialize a set of dataset paths.
`fill_name`(name)	Fill dataset directory name with dataset name.
`get_preprocessed_filepath`(raw_filepath, *[, ...])	Get preprocessed filepath in accordance to filepath of the raw file.
`raw_to_event_filepath`(raw_filepath, *[, ...])	Get event filepath in accordance to filepath of the raw file.

Attributes

`dataset`	The path to the dataset directory.
`downloads`	The path to the directory of the raw data.
`events`	The path to the directory of the event data.
`preprocessed`	The path to the directory of the preprocessed gaze data.
`raw`	The path to the directory of the raw data.
`root`	The root path to your dataset.