aeye-lab / pymovements

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

add tutorial on how to add new datasets #692

Open dkrako opened 4 months ago

dkrako commented 4 months ago

Description of the problem

Currently there is not a step by step guideline on how to contribute datasets to the dataset library.

Description of a solution

Although the contributing.md is a good place to start adding this information, I think it would be best to link from there to a tutorial in our readthedocs page.

The CONTRIBUTING.md could include a link and maybe some more broad description, that we provide a metalibrary of downloadable datasets which are not hosted / provided by us but downloadable via pymovements. More general advices could also be included, like that a fork needs to be created if there's no invite for developing privileges yet.

What the CONTRIBUTING.md could also include is how to test the dataset via tox:

tox -e integration -- tests/integration/public_dataset_processing_test.py::test_public_dataset_processing[PoTeC]

Minimum acceptance criteria