/COBIDAS_chckls

Turns a SPM pipeline into a filled-in COBIDAS checklist

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

COBIDAS checklist

All Contributors

The prototype app for this checklist can be found here: https://cobidas-checklist.herokuapp.com/

This repository host the work turning the report published by the Committee on Best Practices in Data Analysis and Sharing (COBIDAS) of the organization for human brain mapping (OHBM) into a practical tool for improving methods and results reporting in neuroimaging and EEG/MEG.

This repository is a place where:

  1. issues and ideas around reaching this goal are discussed;
  2. plans for how to reach this goal are designed and implemented.

How to reach us

If you want to be kept posted about the progress of the project, you can join our google group.

From more frequent updates and behind the scenes, come and join us on the cobidas_checklist channel on the brainhack mattermost. Join our channel

Otherwise you can open a new issue on the repository itself if there is something you would like to discuss directly here.

There is also an OSF project to centralize all the information and repos.

How to contribute

We are looking for people to give us feedback or help us move forward and implement all of this.

To learn more about the contributors and how to contribute see here.

Why this project

Poor methods and results description hinders the reproducibility and the replicability of research. It also makes it hard to compare new and old results and generally increases inefficiency in the research process. This project is built on the hope that improving methods and results reporting could improve our research.

See here to for more background information.

Goals and roadmap

The short term goal of this project is to make the COBIDAS report easier to use: we want to create a website with a clickable checklist that, at the end, automatically generates most of the method section of a f/MRI or EEG / MEEG paper.

By turning the checklist into a website users could more rapidly click through it and provide more of the information requested by the COBIDAS report. This would generate a small text file (a json file) that summarizes what option was chosen for each item of the checklist. This machine readable file could then be used to automatically generate part of the methods section of an article.

See here for more information on our short and long term goals as well as possible extension to the project. If you are interested by any of those get in touch. Many of them do not necessarily require super-advanced technical skills (except maybe a certain love for working with spreadsheet and wanting them to be super organized) 😉.

We are still in development so we are currently using the list of required inputs from neurovault to work on the user interface.

Implementation

The prototype app for this checklist can be found here: https://cobidas-checklist.herokuapp.com/

The first step of the implementation involves taking a spreadsheet that contains all the items of the checklist and turning that into a representation that can efficiently link the metadata about each item to the data imputed by the user. We are currently using the schema-standardization initiative from ReproNim to do this. Basically it means turning your 'dumb' spreadsheet into an equivalent but 'smarter' representation of it: a bunch hierarchically organized json files that link to each other.

On top of the inherent advantages of this schema representation:

  • its use simplifies the rendering of the checklist by using the schema-ui made for it,
  • this representation allows specification of user interface option that can simplify the user experience: it allows us to specify a branching logic that will prevent users to be presented with items that are not relevant to them (e.g answer PET related when they have only run an fMRI study).

See here for more information about how this whole project is organized

See here for more information on how to work on the checklist on your own computer.

References

Jeanette Mumford has a 30 min video explaining the background behind the COBIDAS report and giving a run through of the checklist.

The COBIDAS report:

The original spreadsheet version of the COBIDAS checklist (thanks to Cass!!!)

Presentation slides made about this project can be found in the presentations folder and here.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Remi Gau

💻 🎨 🖋 🤔 🚇 🚧 📆 🔧 📢

cassgvp

💻 🎨 🖋 🤔 🚇 📢

joyswe

💻 🎨 🖋 🤔 🚇

Federico Adolfi

💻 🎨 🖋 🤔 🚇

Sanu Ann Abraham

💻 🎨 🚇

Thomas Nichols

🎨 🖋 🤔

Anisha Keshavan

💻 🎨 🚇

Satrajit Ghosh

💻 🎨 🚇

Tim van Mourik

💻 🎨 🚇

m-miedema

💻 🎨 🖋 🤔 🚇

David Moreau

🖋 🤔

Zsuzsika Sjoerds

🖋 🤔

angietep

💻 🎨 🖋 🤔 🚇

Martina G. Vilas

💻 🎨 🖋 🤔 🚇

Kristina Wiebels

🖋 🤔

Johannes Algermissen

🖋 🤔

Dorien Huijser

🖋 🤔

Wouter Weeda

🖋 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!