feat: Add kwargs for explicit data passing in gaze.from_numpy()

aeye-lab / pymovements

A python package for processing eye movement data

MIT License

61 stars 12 forks source link

Description

Adds new keyword arguments to pass time, position, velocity numpy arrays as keyword arguments to pm.gaze.from_numpy()

Fixes issue #501

Implemented changes

[x] Make data and schema argument optional
[x] Add time, pixel, position, velocity, acceleration arguments

Type of change

[x] New feature (non-breaking change which adds functionality)
[x] This change is or requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

[x] Test full specification with schema
[x] Test full specification with explicit lists
[x] Test all None

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 Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (380df1e) 100.00% compared to head (217b1f0) 100.00%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #513 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 48 48 Lines 2081 2117 +36 Branches 505 511 +6 ========================================= + Hits 2081 2117 +36 ``` | [Files Changed](https://app.codecov.io/gh/aeye-lab/pymovements/pull/513?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab) | Coverage Δ | | |---|---|---| | [src/pymovements/gaze/integration.py](https://app.codecov.io/gh/aeye-lab/pymovements/pull/513?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aeye-lab#diff-c3JjL3B5bW92ZW1lbnRzL2dhemUvaW50ZWdyYXRpb24ucHk=) | `100.00% <100.00%> (ø)` | |

aeye-lab / pymovements