search

psychoinformatics-de / remodnav

Robust Eye Movement Detection for Natural Viewing
Other
59 stars 16 forks source link

Assume less expert knowledge in description #11

Open mih opened 5 years ago

mih commented 5 years ago

remodnav --help states

  <datafile>      Data file with eye gaze recordings to process. The
                        first two columns in this file must contain X and Y
                        coordinates, while each line is a timepoint (no
                        header). The file is read with NumPy's recfromcsv and
                        may be compressed.

Users familiar with the referenced function will know how flexible it is and can infer many aspects of supported file formats. However, the fact that remodnav is written in Python and uses NumPy should not have to be critical knowledge for its users.

We should spell out the file format requirements.