aeye-lab / pymovements

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

teaser usability of pymovements datasets #637

Closed SiQube closed 6 months ago

SiQube commented 7 months ago

I think it would be cool to teaser one of our use cases (easy accessiblity of datasets) more prominently on the README.md, e.g. adding something like:

Easily access public eye movements datasets in three lines of code:

import pymovmements as pm

dataset = pm.Dataset('JuDo1000', path='data/ToyDataset')
dataset.download(remove_finished=True)
dataset.extract(remove_finished=True)
dkrako commented 6 months ago

Good idea! We can simplify this example even more by focusing on the most prominent usecase:

import pymovmements as pm

dataset = pm.Dataset('JuDo1000', path='data/judo100')  # setup your local dataset path
dataset.download()  # download a public dataset from our dataset library
dataset.load()  # load the dataset into working memory

We can also add two more short example blocks:

dataset.pixdeg()  # transform pixel coordinates to degrees of visual angle
dataset.pos2vel()  # transform positional data to velocity data
dataset.detect('ivt')  # detect fixation using the I-VT algorithm
dataset.detect('microsaccades')  # detect saccades using the microsaccades algorithm
SiQube commented 6 months ago

resolved via #639