Checklist: HBCD EEG Utilities

[ChildDevLab]

Checklist content

{
  "name": "HBCD EEG Utilities",
  "urls": [
    {
      "url_type": "Source code",
      "url": "https://github.com/Child-Development-Lab/HBCD-EEG-Utilities"
    },
    {
      "url_type": "Documentation",
      "url": "https://hbcd-eeg-utilities.readthedocs.io/en/latest/"
    }
  ],
  "documentation": {
    "bronze": {
      "1": true,
      "2": true,
      "3": true,
      "4": true,
      "5": true,
      "6": true,
      "7": true,
      "8": true,
      "9": true
    },
    "silver": {
      "1": false,
      "2": true,
      "3": false,
      "4": false,
      "5": false,
      "6": false
    },
    "gold": {
      "1": false,
      "2": false,
      "3": false,
      "4": false,
      "5": false,
      "6": false
    }
  },
  "infrastructure": {
    "bronze": {
      "1": true,
      "2": true,
      "3": true,
      "4": true,
      "5": true,
      "6": true,
      "7": true
    },
    "silver": {
      "1": false,
      "2": false,
      "3": false
    },
    "gold": {
      "1": false,
      "2": false,
      "3": false,
      "4": false,
      "5": false
    }
  },
  "testing": {
    "bronze": {
      "1": false,
      "2": false
    },
    "silver": {
      "1": false,
      "2": false
    },
    "gold": {
      "1": false,
      "2": false
    }
  }
}

Additional information

No response

Agreement

• I agree

[LuciMoore]

@kaitj here is another utility we would like to have reviewed for HBCD. I think this one should be fairly straightforward - let me know if someone on your team has the bandwidth to perform the review, otherwise I can do it or assign it to someone on my team

Tagging the submitter @kasenetz so she can follow up once the third-party review is posted! Thanks!

@kasenetz FYI I went ahead and updated the json above to switch the bronze test checklist items for false per our slack discussion

[kaitj]

Hi @kasenetz, @LuciMoore,

Largely looks good. I wasn't able to test out the installation as I didn't have a matlab license readily available, but the instructions seem straightforward (if someone else wants to try to install it or I can try later on since there are a few minor things that need to addressed). Overall, looks good - I've left my comments below:

• Documentation
  • Bronze
    • Description of required inputs - would it be possible to make this more visible? It's there in the tutorial, but it's a little bit hidden.
  • Silver
    • Tutorial showcasing usage - this can be checked off, there is a tutorial there that demonstrates usage.
• Infrastructure
  • Bronze
    • DOI - currently points to v1.0.0, I believe Zenodo provides one that will always point to latest
    • Installation instructions - these look good; would consider splitting the matlab and eeglab instructions to separate headings; would also consider renaming "Download GitHub Repository" to "Installing HCBD-EEG-Utilities" or something that reflects the scripts being "installed"
  • Silver
    • No excessive files - there are 2 files in the repo that I'm not sure are necessary (1) HBCD_EEG_Utilities.asv, which looks like an autosave of the matlab file, and (2) HBCD_ERPs_timewindows_for_age_groups.xlsx, which I couldn't find immediately if it was being called somewhere. If these are removed (or if they are necessary) could also check this box off).

and an updated checklist:

{
  "name": "HBCD EEG Utilities",
  "urls": [
    {
      "url_type": "Source code",
      "url": "https://github.com/Child-Development-Lab/HBCD-EEG-Utilities"
    },
    {
      "url_type": "Documentation",
      "url": "https://hbcd-eeg-utilities.readthedocs.io/en/latest/"
    }
  ],
  "documentation": {
    "bronze": {
      "1": true,
      "2": true,
      "3": true,
      "4": true,
      "5": true,
      "6": true,
      "7": true,
      "8": true,
      "9": true
    },
    "silver": {
      "1": false,
      "2": true,
      "3": false,
      "4": false,
      "5": false,
      "6": false
    },
    "gold": {
      "1": false,
      "2": false,
      "3": false,
      "4": false,
      "5": false,
      "6": false
    }
  },
  "infrastructure": {
    "bronze": {
      "1": true,
      "2": true,
      "3": true,
      "4": true,
      "5": true,
      "6": true,
      "7": true
    },
    "silver": {
      "1": false,
      "2": false,
      "3": false
    },
    "gold": {
      "1": false,
      "2": false,
      "3": false,
      "4": false,
      "5": false
    }
  },
  "testing": {
    "bronze": {
      "1": false,
      "2": false
    },
    "silver": {
      "1": false,
      "2": false
    },
    "gold": {
      "1": false,
      "2": false
    }
  }
}

[LuciMoore]

thanks for the quick turnaround, @kaitj !

@kasenetz here are some suggestions based on Jason's comments, hope it helps!

Documentation / Bronze / Description of required inputs - would it be possible to make this more visible? It's there in the tutorial, but it's a little bit hidden.

Perhaps you could rename Tutorial to Usage & Tutorial and move that section to follow Installation? Then for the subsections of the Usage page, you could include: BIDS Input Data and Execution in Matlab. Would it also be possible to add a section for Execution From Command Line, or is it just easier to use the MATLAB GUI with the way the code is written? I would also create a separate page for How to Download HBCD EEG Data and add that before or after Usage in the table of contents

Infrastructure / Bronze / DOI - currently points to v1.0.0, I believe Zenodo provides one that will always point to latest

Use 10.5281/zenodo.15483798 to always point to latest

[kasenetz]

Hi all, thanks for the quick turnaround and the feedback!
I can make these changes. Users will need to use the MATLAB GUI to run the utiltlies, so we won't need a section for execution from the command line. I'll let you know when it's all set- I should be done by tomorrow morning.

[LuciMoore]

@kaitj and @kasenetz because the checklist won't be impacted by these improvements and I trust Whitney to make the suggested updates in a reasonable timeframe, I'm going to go ahead and approve to add to the tools page so that I can update the HBCD Release Docs website. feel free to re-open if there are any concerns!

I have updated the json above with Kevin's version

[github-actions]

✅ Your new NMIND badge has been generated!:

🔗 Badge URL:

https://img.shields.io/badge/NMIND-17%2F42-orange?logo=data:image/svg+xml;base64,PHN2ZyB2aWV3Qm94PSIwIDAgMjQgMjQiIGZpbGw9IiNDRDdGMzIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CiAgPHBhdGggZD0iTTMuMzc3NTIgNS4wODI0MUMzIDUuNjIwMjggMyA3LjIxOTA3IDMgMTAuNDE2N1YxMS45OTE0QzMgMTcuNjI5NCA3LjIzODk2IDIwLjM2NTUgOS44OTg1NiAyMS41MjczQzEwLjYyIDIxLjg0MjQgMTAuOTgwNyAyMiAxMiAyMkMxMy4wMTkzIDIyIDEzLjM4IDIxLjg0MjQgMTQuMTAxNCAyMS41MjczQzE2Ljc2MSAyMC4zNjU1IDIxIDE3LjYyOTQgMjEgMTEuOTkxNFYxMC40MTY3QzIxIDcuMjE5MDcgMjEgNS42MjAyOCAyMC42MjI1IDUuMDgyNDFDMjAuMjQ1IDQuNTQ0NTQgMTguNzQxNyA0LjAyOTk2IDE1LjczNTEgMy4wMDA3OUwxNS4xNjIzIDIuODA0NzJDMTMuNTk1IDIuMjY4MjQgMTIuODExNCAyIDEyIDJDMTEuMTg4NiAyIDEwLjQwNSAyLjI2ODI0IDguODM3NzIgMi44MDQ3Mkw4LjI2NDkxIDMuMDAwNzlDNS4yNTgzMiA0LjAyOTk2IDMuNzU1MDMgNC41NDQ1NCAzLjM3NzUyIDUuMDgyNDFaIi8+Cjwvc3ZnPgo=

📄 To embed this badge in a README.md, use the following Markdown:

[![HBCD_EEG_Utilities](https://img.shields.io/badge/NMIND-17%2F42-orange?logo=data:image/svg+xml;base64,PHN2ZyB2aWV3Qm94PSIwIDAgMjQgMjQiIGZpbGw9IiNDRDdGMzIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CiAgPHBhdGggZD0iTTMuMzc3NTIgNS4wODI0MUMzIDUuNjIwMjggMyA3LjIxOTA3IDMgMTAuNDE2N1YxMS45OTE0QzMgMTcuNjI5NCA3LjIzODk2IDIwLjM2NTUgOS44OTg1NiAyMS41MjczQzEwLjYyIDIxLjg0MjQgMTAuOTgwNyAyMiAxMiAyMkMxMy4wMTkzIDIyIDEzLjM4IDIxLjg0MjQgMTQuMTAxNCAyMS41MjczQzE2Ljc2MSAyMC4zNjU1IDIxIDE3LjYyOTQgMjEgMTEuOTkxNFYxMC40MTY3QzIxIDcuMjE5MDcgMjEgNS42MjAyOCAyMC42MjI1IDUuMDgyNDFDMjAuMjQ1IDQuNTQ0NTQgMTguNzQxNyA0LjAyOTk2IDE1LjczNTEgMy4wMDA3OUwxNS4xNjIzIDIuODA0NzJDMTMuNTk1IDIuMjY4MjQgMTIuODExNCAyIDEyIDJDMTEuMTg4NiAyIDEwLjQwNSAyLjI2ODI0IDguODM3NzIgMi44MDQ3Mkw4LjI2NDkxIDMuMDAwNzlDNS4yNTgzMiA0LjAyOTk2IDMuNzU1MDMgNC41NDQ1NCAzLjM3NzUyIDUuMDgyNDFaIi8+Cjwvc3ZnPgo=)](https://www.nmind.org/proceedings/hbcd-eeg-utilities/)

[kaitj]

@LuciMoore - I manually fixed the generated badge for this one while working on fixing the script.

[kasenetz]

Hi all, thanks for the help and feedback! I made the suggested changes to the documentation.