mne-python icon indicating copy to clipboard operation
mne-python copied to clipboard

Complete FieldTrip neighbors descriptions

Open hoechenberger opened this issue 2 years ago • 2 comments

We've added lots of new FieldTrip neighbors (adjacency matrices) definitions and corresponding descriptions in #10749

However, for a number of the neighbors, I was unable to find a proper description, and the respective field remained blank (empty string). We should aim to get them filled.

Maybe this could be part of our upcoming sprint? @drammock I'll leave it to you to judge :)

hoechenberger avatar Jun 15 '22 21:06 hoechenberger

where would folks look up the description if it's not obvious to them what it ought to be?

drammock avatar Jun 15 '22 22:06 drammock

I took the existing descriptions from the FT website, maybe I overlooked some. Hence, my approach would be the following (in that order):

  • For each built-in FT neighbors file, check if it exists in the FT repository
  • If it does, check if there's any description on https://www.fieldtriptoolbox.org/template/neighbours/ that I maybe simply overlooked
  • If there isn't one, probably ask on the FT issue tracker (?) as to how those "unknown" neighbor definitions were created
  • If the file does not exist on the FT repository, ask the MNE developers if they know where that file comes from; potentially use the Git history feature to figure out who added the file to MNE, and when

hoechenberger avatar Jun 16 '22 07:06 hoechenberger