Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Utilize templates for our scripts #47

Open
choldgraf opened this issue Mar 26, 2018 · 3 comments
Open

Utilize templates for our scripts #47

choldgraf opened this issue Mar 26, 2018 · 3 comments
Labels
documentation tasks relating to improving our documentation enhancement requests to add something new to the project

Comments

@choldgraf
Copy link
Collaborator

Right now we have scripts that use python/matlab to generate various BIDS structures, e..g.:

Python: https://github.com/choldgraf/bids-starter-kit/blob/master/pythonCode/createBIDS_dataset_description_json.py

Matlab: https://github.com/INCF/bids-starter-kit/blob/master/matlabCode/createBIDS_dataset_description_json.m

Whereas we also have a nicely-detailed template that's language-agnostic and in the "final" BIDS format:
https://github.com/INCF/bids-starter-kit/blob/master/templates/dataset_description.json

I propose that, wherever we have a pre-defined template such as this, instead of re-creating the same structure with raw matlab/python, we provide code to read in the template and show how to update the fields. This would make things much easier to maintain, and separates out the data structure from the scripting code itself.

What do folks think? If y'all are +1, I think this would be a great new contributor issue as well

@dorahermes
Copy link
Member

I am happy that you like the templates.

I actually like the raw scripts, first because they have descriptions of what to enter in each field and second because the Matlab script can be used to create metadata for several subjects at once.

I agree with the fact that it is difficult that the same template is generated by both the Matlab and Python code. However, this could be a sanity check for when people contribute R/Julia/? scripts.

@KirstieJane KirstieJane added enhancement requests to add something new to the project documentation tasks relating to improving our documentation labels Jun 15, 2018
@KirstieJane
Copy link
Member

Ohhh - I'm working upwards from old to new and I realise that this conversation should also be incorporated into #58 and #57....... sorry for somewhat confusing the issue.

Can I suggest that we have "philosophical" discussions at #57 and close that issue out first, and then return to this issue (and the very highly related #58) once we're done there?

@choldgraf
Copy link
Collaborator Author

choldgraf commented Jun 15, 2018

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation tasks relating to improving our documentation enhancement requests to add something new to the project
Projects
None yet
Development

No branches or pull requests

3 participants