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

Harmonise code samples across languages #58

Open
2 tasks
KirstieJane opened this issue Jun 15, 2018 · 0 comments
Open
2 tasks

Harmonise code samples across languages #58

KirstieJane opened this issue Jun 15, 2018 · 0 comments
Labels
documentation tasks relating to improving our documentation enhancement requests to add something new to the project help-wanted if you're looking to help us, these are great places to start!

Comments

@KirstieJane
Copy link
Member

[caveat] This might be a bit of a big task (I think @Park-Patrick can do it for matlab and python, but we might want to recruit a new contributor to translate into R or any other language).

Before we get started it would be great to be all on the same page about what we're trying to achieve: (see #57 - what is the point of the code samples in this repo).

Once #57 is closed out, the next step is to make sure that what's inside the folders (matlabCode, pythonCode etc) are the same.

I think this means making sure that:

  • Each folder has a README file that contains basically the same information, explaining how you can use the scripts and why you'd want to
  • The files are all the same. At the moment the pythonCode folder only has createBIDS_dataset_description_json.py while the matlabCode has a lot of different files. It would be great if these were harmonised.

Once these steps are complete, we could get back to #35 and add in an RCode folder ✨

@KirstieJane KirstieJane added enhancement requests to add something new to the project help-wanted if you're looking to help us, these are great places to start! documentation tasks relating to improving our documentation labels Jun 15, 2018
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 help-wanted if you're looking to help us, these are great places to start!
Projects
None yet
Development

No branches or pull requests

1 participant