https://github.com/bids-standard/eye2bids

Convert eyetracking data to a BIDS compatible format (BEP20)

https://github.com/bids-standard/eye2bids

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Convert eyetracking data to a BIDS compatible format (BEP20)

Basic Info
  • Host: GitHub
  • Owner: bids-standard
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 2.33 MB
Statistics
  • Stars: 11
  • Watchers: 6
  • Forks: 5
  • Open Issues: 15
  • Releases: 0
Created almost 3 years ago · Last pushed 9 months ago
Metadata Files
Readme License

README.md

test

eye2bids

Installation

Requirements

  • Python >= 3.8

If you want to use eye2bids to convert EyeLink data, you will need to install the EyeLink Developers Kit. It can be downloaded from SR-Research support forum (forum registration required).

The installation on Ubuntu can also be done with the following commands:

Taken from: https://www.sr-research.com/support/docs.php?topic=linuxsoftware

bash sudo add-apt-repository universe sudo apt update sudo apt install ca-certificates sudo apt-key adv --fetch-keys https://apt.sr-research.com/SRResearch_key sudo add-apt-repository 'deb [arch=amd64] https://apt.sr-research.com SRResearch main' sudo apt update sudo apt install eyelink-display-software

Install eye2bids

  • Clone the repository

bash git clone https://github.com/bids-standard/eye2bids.git

  • Install the package in editatble mode

bash cd eye2bids pip install .

Using eye2bids

  • Supporeted Input data:

    • edf file by EyeLink Eye Tracker
  • manualmetadata.yml file (find template and an example in conversionjson folder)

Run code

bash eye2bids --input_file INPUT_FILE --metadata_file METADATA_FILE

Usage: eye2bids [-h] [-v] --input_file INPUT_FILE --metadata_file METADATA_FILE [--output_dir OUTPUT_DIR] [-i] [--verbosity {0,1,2,3}]
                [--input_type INPUT_TYPE]

Converts eyetracking data to a BIDS compatible format.

Options:
-h, --help            show this help message and exit
-v, --version         show program's version number and exit
--input_file INPUT_FILE
                        Path to the input file to convert.
--metadata_file METADATA_FILE
                        Path to the a yaml file containing extra metadata.
--output_dir OUTPUT_DIR
                        Path to output directory.
-i, --interactive     To run in interactive mode.
--verbosity {0,1,2,3}
                        Verbosity level.
--input_type INPUT_TYPE
                        Input type if it cannot be determined from input_file.

Docker

You can build the docker image with the following command:

bash docker build -t eye2bids:latest .

Related projects

Owner

  • Name: Brain Imaging Data Structure
  • Login: bids-standard
  • Kind: organization

GitHub Events

Total
  • Issues event: 9
  • Watch event: 3
  • Delete event: 14
  • Issue comment event: 19
  • Push event: 61
  • Pull request review event: 4
  • Pull request review comment event: 3
  • Pull request event: 33
  • Create event: 17
Last Year
  • Issues event: 9
  • Watch event: 3
  • Delete event: 14
  • Issue comment event: 19
  • Push event: 61
  • Pull request review event: 4
  • Pull request review comment event: 3
  • Pull request event: 33
  • Create event: 17

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 5
  • Total pull requests: 11
  • Average time to close issues: 5 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 4.6
  • Average comments per pull request: 0.27
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 6
Past Year
  • Issues: 4
  • Pull requests: 11
  • Average time to close issues: 4 months
  • Average time to close pull requests: about 1 month
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 3.0
  • Average comments per pull request: 0.27
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 6
Top Authors
Issue Authors
  • julia-pfarr (16)
  • Remi-Gau (5)
  • dlevitas (1)
  • arnodelorme (1)
  • pre-commit-ci[bot] (1)
Pull Request Authors
  • pre-commit-ci[bot] (30)
  • julia-pfarr (13)
  • Remi-Gau (8)
  • dependabot[bot] (1)
Top Labels
Issue Labels
enhancement (2) bug (2)
Pull Request Labels
bug (4) dependencies (1) github_actions (1) enhancement (1)