feat: Add gaze.from_asc()

dkrako commented 9 months ago

Description

Implement from_eyelink_asc() which returns a GazeDataFrame read from an eyelink asc file.

Fixes issue #508

Type of change

[x] New feature (non-breaking change which adds functionality)

How Has This Been Tested?

[x] Created test asc file and check GazeDataFrame for correct shape

Checklist:

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules
[x] I have checked my code and corrected any misspellings

codecov[bot] commented 9 months ago

Codecov Report

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

Comparison is base (06b1034) 100.00% compared to head (73200d9) 100.00%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #590 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 53 53 Lines 2376 2388 +12 Branches 597 599 +2 ========================================= + Hits 2376 2388 +12 ```

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

dkrako commented 8 months ago

I'll wait for merging this until after the release on coming friday. Then I'll have time to add some proper documentation on how to use all the pattern magic here.

The release on coming friday will probably only include bug fixes and maintenance work (->v0.17.1).

aeye-lab / pymovements