aeye-lab / pymovements

A python package for processing eye movement data
https://pymovements.readthedocs.io
MIT License
57 stars 11 forks source link

docs: add missing column argument docs and note on csv column dtypes #594

Closed jakobchwastek closed 7 months ago

jakobchwastek commented 9 months ago

In this pull request, I've extended the documentation to include previously undocumented arguments in the DatasetDefinition class. The newly documented arguments are:

trial_columns: list[str] | None = None
time_column: str | None = None
pixel_columns: list[str] | None = None
position_columns: list[str] | None = None
velocity_columns: list[str] | None = None
acceleration_columns: list[str] | None = None

Furthermore I added a description to better understand the custom_read_kwargs argument and to which function it will be passed.

As you know I also encountered issues with polars.read_csv inferring wrong data types, leading to failures in the pos2vel transformation. To assist users who might face similar problems I included a note in the documentation.

Let me know if any further refinements are needed.

codecov[bot] commented 9 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (2560601) 100.00% compared to head (9ee03ca) 100.00%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #594 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 53 53 Lines 2388 2388 Branches 599 599 ========================================= Hits 2388 2388 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.