Skip to content

Commit

Permalink
update docstring of sb_sat dataset definition
Browse files Browse the repository at this point in the history
  • Loading branch information
SiQube committed Sep 27, 2024
1 parent 0428e49 commit cb9c46d
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion src/pymovements/datasets/sb_sat.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ class SBSAT(DatasetDefinition):
name: str
The name of the dataset.
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 '/'.
Expand All @@ -59,6 +63,9 @@ class SBSAT(DatasetDefinition):
- `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 @@ -70,10 +77,31 @@ class SBSAT(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.
pixel_columns: list[str]
The name of the pixel position columns in the input data frame. These columns will be
nested into the column ``pixel``. If the list is empty or None, the nested ``pixel``
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, dict[str, Any]]]
custom_read_kwargs: dict[str, dict[str, Any]]
If specified, these keyword arguments will be passed to the file reading function.
Examples
Expand Down

0 comments on commit cb9c46d

Please sign in to comment.