Skip to content

Commit

Permalink
update docstring of gazebasevr dataset definition (#828)
Browse files Browse the repository at this point in the history
  • Loading branch information
SiQube committed Sep 30, 2024
1 parent fdab5de commit 242aabe
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions src/pymovements/datasets/gazebasevr.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,23 @@ class GazeBaseVR(DatasetDefinition):
name: str
The name of the dataset.
gaze_mirrors: dict[str, tuple[str, ...]]
has_files: dict[str, bool]
Indicate whether the dataset contains 'gaze', 'precomputed_events', and
'precomputed_reading_measures'.
mirrors: dict[str, tuple[str, ...]]
A tuple of mirrors of the dataset. Each entry must be of type `str` and end with a '/'.
gaze_resources: dict[str, tuple[dict[str, str], ...]]
A tuple of dataset resources. Each list entry must be a dictionary with the following keys:
resources: dict[str, tuple[dict[str, str], ...]]
A tuple of dataset gaze_resources. Each list entry must be a dictionary with the following
keys:
- `resource`: The url suffix of the resource. This will be concatenated with the mirror.
- `filename`: The filename under which the file is saved as.
- `md5`: The MD5 checksum of the respective file.
extract: dict[str, bool]
Decide whether to extract the data.
experiment: Experiment
The experiment definition.
Expand All @@ -76,12 +84,34 @@ class GazeBaseVR(DatasetDefinition):
If named groups are present in the `filename_format`, this makes it possible to cast
specific named groups to a particular datatype.
trial_columns: list[str]
The name of the trial columns in the input data frame. If the list is empty or None,
the input data frame is assumed to contain only one trial. If the list is not empty,
the input data frame is assumed to contain multiple trials and the transformation
methods will be applied to each trial separately.
time_column: str
The name of the timestamp column in the input data frame. This column will be renamed to
``time``.
time_unit: str
The unit of the timestamps in the timestamp column in the input data frame. Supported
units are 's' for seconds, 'ms' for milliseconds and 'step' for steps. If the unit is
'step' the experiment definition must be specified. All timestamps will be converted to
milliseconds.
position_columns: list[str]
The name of the dva position columns in the input data frame. These columns will be
nested into the column ``position``. If the list is empty or None, the nested
``position`` column will not be created.
column_map: dict[str, str]
The keys are the columns to read, the values are the names to which they should be renamed.
custom_read_kwargs: dict[str, dict[str, Any]]
If specified, these keyword arguments will be passed to the file reading function.
Examples
--------
Initialize your :py:class:`~pymovements.PublicDataset` object with the
Expand Down

0 comments on commit 242aabe

Please sign in to comment.