annotate_run_id#

pymovements.measure.reading.annotate_run_id(fixations: DataFrame, group_columns: list[str]) → DataFrame[source]#

Annotate fixations with run IDs.

A run is a contiguous sequence of fixations on the same word.

Parameters:

  • fixations (pl.DataFrame) – Fixation-level DataFrame. Must contain a word_idx column.

  • group_columns (list[str]) – Column names used to partition the data into independent reading sequences.

Returns:

Input DataFrame with an additional run_id column.

Return type:

pl.DataFrame