next_word_idx#

pymovements.measure.reading.next_word_idx(word_idx: str | Expr = 'word_idx') → Expr[source]#

Get the word index of the next fixation.

Apply .over(group_columns) to partition into independent reading sequences.

Warning

Requires onset-sorted input within each sequence.

Parameters:

word_idx (str | pl.Expr) – Column name or expression of the fixated word index. (default: 'word_idx')

Returns:

Expression producing the next_word_idx column.

Return type:

pl.Expr