mne-tools / mne-tools/mne-python

RFC: in search of the perfect sample data

Open
#6,644 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Description

After revising lots of tutorials, I've formed some opinions about what the ideal sample dataset would look like. Here are some thoughts; please feel free to edit / add to the list; maybe if we reach some consensus we can find a dataset that meets the criteria and could replace sample dataset in most/all of the tutorials.

  • probably should be neuromag and include fine cal, crosstalk, and a cHPI .pos file (current sample data lacks .pos)
  • has mag, grad, EEG, EOG, and ECG (current sample data lacks ECG)
  • has multiple subjects (useful for demoing corrmap, stats, ...)
  • multiple runs per subject maybe? (for things like concatenating raws)
  • a single Raw recording is ~90 seconds max, and/or has a low-ish acquisition sampling frequency (so we're not constantly cropping to save memory)
  • raw file does not already contain projectors; separate empty-room file included
  • I think the task (L/R aud/vis + catch trials) is pretty good as a demo, but might be nice to have reaction time data included (for things like the epochs image overlay). I'm certainly open to other ideas about the paradigm though.
  • EEG channel names follow 10-20 / 10-05 naming conventions

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the current sample dataset and the tutorial uses referenced in the issue, then compare them with the listed acquisition, channel, subject, run, and file requirements. Done means reaching consensus on a replacement dataset and its criteria; the issue does not name implementation files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.