pymovements v0.19.0

💥 Breaking Changes

• split in definition custom_read_kwargs to gaze and precomputed_events… (#791)
• rename resource to gaze_resource (#759)
• enable fixation only datasets (#771)

✨ Enhancements

• add stimulus to plotting (#799)
• add feature to split precomputed events dataframe by columns (#802)
• Add trial_columns argument in from_asc() (#898)
• Store metadata from ASC in experiment metadata (#884)
• add support for .ias files in stimulus.text.from_file() (#858)
• Avoid event-gaze join to improve memory efficiency when calculating event properties (#768)
• add resample() transformation function (#720)
• map gaze data to aois (#747)
• aoi mapping extended to end coordinate instead of width/height (#851)
• adjust aoi mapping to aoi dataframe columns (#848)
• Custom patterns for parsing logged metadata in ASC files (#767)
• Event aoi mapping (#784)
• enable scanpath plotting (#782)
• add new feature for image stimuli (#779)
• autodetect column names (#719)
• support 2kHz ASC files with floating-point timestamps (#739)
• Add __str__() methods to EventDataFrame and GazeDataFrame (#727)
• parse eyelink mount config and pupil data type (#725)
• make all arguments in screen and experiment optional (#721)
• add feature for precomputed reading measures (#804)

📀 Datasets

• add InteRead dataset (#862)
• beijing sentence corpus (#857)
• enable downloading precomputed events for copco dataset (#840)
• correct trial columns in SB-SAT dataset (#855)
• fix sb sat wrong experiment config (#778)
• CopCo dataset precomputed events loading (#873)
• add raw data to copco (#854)
• specify custom_read_kwargs in copco to enable loading precomputed_events (#842)
• code comprehension (#805)
• add trial_columns to copco (#807)
• added fakenews dataset (#806)
• add didec dataset and tests (#801)
• Copco dataset (#797)
• Emtec dataset (#796)
• change column types from Int32 to Int64 in DatasetDefinitions (#751)

🐞 Bug Fixes

• aoi test file contained multiple screens (#864)
• correctly add EyeTracker class to gaze module (#876)
• download link fakenewsperception dataset (#897)
• copy event resource files instead of moving them to events directory (#863)
• fix stimulus text wrong handling of missing values (#811)
• fix docstrings of public datasets using wrong definition (#790)
• fix text stimulus doc string (#762)
• as per repository types-all is deprecated (#774)
• default traceplot cmaps (#763)
• Don't override kwargs in EventGazeProcessor (#760)
• add subject ID to dataset trial columns (#752)
• cast numerical columns to Float64 when reading CSV (#746)
• operator precedence when building group_filter_expression (#734)
• fix ylim in tsplot for non-centered yaxis (#729)

🛠️ Maintenance

• fix automated documentation by pinning sphinx to be <7.4 (#754)
• Fix issue linking in PR template (#761)
• check whether public dataset has gaze files (#872)
• depecated importing ColumnNotFoundError from top level (#808)
• explicitly orient dataframe construction (#810)
• docstring of traceplot had wrong pad_value default (#792)
• merge tests for public datasets in a single file (#785)
• Linter: double indent checker (#788)
• fix part of matplotlib lines are type ignored (#789)
• remove debug print statements in tests (#770)
• add tests/preprocessed/ and toy_dataset to gitignore (#764)
• double indent linter destroyed my tests (#793)
• add emtec example files and functional tests (#800)
• precomputed event docstring (#803)
• update transforms tests to account for adding single line (#815)
• update docstring of didec dataset definition (#822)
• update docstring of emtec dataset definition (#823)
• update docstring of gaze_graph dataset definition (#825)
• update docstring of gazes_on_faces dataset definition (#826)
• update docstring of gazebase dataset definition (#827)
• update docstring of gazebasevr dataset definition (#828)
• update docstring of hbn dataset definition (#829)
• update docstring of judo1000 dataset definition (#830)
• update docstring of potec dataset definition (#831)
• update docstring of sb_sat dataset definition (#832)
• update docstring of toy_dataset dataset definition (#833)
• update docstring of toy_dataset_eyelink dataset definition (#834)
• update docstring of events processing (#835)
• update docstring of gaze experiment (#836)
• update docstring of gaze screen (#837)
• update docstring of fakenews dataset definition (#824)
• update docstring of dataset definition (#820)
• update docstring of copco dataset definition (#821)
• update docstring of utils downloads (#838)
• upgrade to polars 1+ (#809)
• missed ColumnNotFoundError (#816)
• space raises converting problems for polars1+ (#814)
• adjust docstring checks are not none (#850)
• ignore: vim swap files (#844)
• Add missing modules to documentation (#866)
• add CITATION.cff (#901)
• update setuptools-git-versioning requirement from <2 to <3 (#895)
• update nbsphinx requirement from <0.9.5,>=0.8.8 to >=0.8.8,<0.9.6 (#777)
• add support for python 3.13 (#845)
• ignore too-many-public-methods (#882)
• upgrade pyarrow (#846)
• update pydoclint in pre-commit config (#819)
• update nbconvert requirement from <7.14,>=7.0.0 to >=7.16.4,<7.17 (#741)
• manually update pre-commit config (#818)
• refactor public dataset tests into 'gaze' and 'precomputed_events' (#795)
• exchange seperate arguments for dicts in dataset definition (#794)
• as per repository types-all is deprecated (#774)
• update pyarrow requirement from <17,>=11.0.0 to >=11.0.0,<18 (#765)
• update numpy requirement from <2,>=1.22.4 to >=1.22.4,<3 (#736)
• update matplotlib requirement from <3.9,>=3.8.0 to >=3.8.0,<3.10 (#731)
• update nbsphinx requirement from <0.9.4,>=0.8.8 to >=0.8.8,<0.9.5 (#728)
• update pyarrow requirement from <16,>=11.0.0 to >=11.0.0,<17 (#722)
• use macos-13 instead of macos-latest for python 3.9 (#724)

👷👷‍♀️👷‍♂️ Contributors

Shoutout to all our contributors for making this release possible!
@SiQube, @aarbeikop, @dkrako, @jakobchwastek, @josephine-funken, @prassepaul, @saeub and @theDebbister