Create your own app: “a test run for the documentation”
Remi-Gau opened this issue · 0 comments
Is the documentation good enough for you to go from a paper version of some guidelines, all the way to build your own app?
One of the goals of this project is also to provide a friendly tool-kit for anyone who would like to create their own version of the app but for a completely different set of guidelines. For this, it is important for the documentation to be as clear and as helpful as possible.
At the moment it is far from the perfect step by step guide but there is already some information on where to find the different moving pieces of this project and how to use them.
A good way to improve is to start with a new checklist or set of guidelines either in a "paper" format or maybe already in a table format and see what information is missing or unclear along the way. We can then update the documentation to fill in those gaps.
If you don't have your own "guidelines" that you want to convert into an app (I realize not everyone collects them 😉) then there are different possibilities:
- start a new checklist from this recent preprint "A Methodological Checklist for fMRI Drug Cue Reactivity Studies: Development and Expert Consensus"
- start using some of the items from the EEG/MEG spreadsheet and turn that into its own app
- extract some of the items of the MRI spreadsheet (for example related to participants description or to the physio parameters of an experiment) and convert that into its own stand alone app.
Needs reviewing
- the main repo documentation : https://remi-gau.github.io/eCobidas/
- the reproschema "stable' documentation : https://www.repronim.org/reproschema/
- the reproschema "latest' documentation : work in progress in this pull request ReproNim/reproschema#399