BIDS Specification Terms PDF Table Generator

nqueder commented 4 years ago

Project info

Title: BIDS Specification Terms PDF Table Generator

Project lead: Nazek Queder @nqueder

Hub: The Americas

Description:

The project aims to create a user-friendly python tool allowing the BIDS group to select, search, or add BIDS specification terms and export a PDF table of the chosen BIDS term along with appropriate term properties and instructions on adding new terms. If the user chooses to add a new term, the tool will create and export a new BIDS specification term as a JSON-LD file and push it to our terms repository where discussion surrounding the new term can be captured using git/github. Such an effort will provide the BIDS working group with a user-friendly tool to build tables for the BIDS documentation while ensuring they have not re-purposed an existing BIDS specification term giving it conflicting definitions. For additional information on the background for this project see BIDS specification issue 423.

Link to project: https://github.com/nqueder/bids_terms_to_pdf_table

Mattermost handle: @nazek.queder

Goals for the OHBM Brainhack

Create a Python-based tool allowing users to specify subsets of BIDS specification terms and properties of those terms to include in a PDF-formatted table for inclusion into specifications.
Create JSON-LD files for newly added BIDS specification terms.
Creating a document with clear instructions for the user on how to use our tool.
Create an automated way to push newly created JSON-LD files to the Interlex information resource.

Good first issues:

Create a Scicrunch account and generate a new Interlex API key, for instructions on how to generate an Interlex API key please visit our github repository.
Review the BIDS specification documents and our NIDM-Terms repository and get familiar with our current group of BIDS terms.

Skills:

Python
Data query
Git - any level
BIDS - Brain Imaging Data Structure
Knowledge about JSON and JSON-LD is recommended but not required
Someone who knows how to develop good, tidy and clear documentation for developing clear and well structured user’s instructions
Someone with good research and document analysis skills

Chat channel: https://mattermost.brainhack.org/brainhack/channels/hbm_bids-terms-to-pdf

Video Channel: Please have a look at the Mattermost channel (pinned posts) for the URL of the video channel, or alternatively, please contact to @nazek.queder on Mattermost.

Image for the OHBM brainhack website

Project submission

Submission checklist

Once the issue is submitted, please check items in this list as you add under 'Additional project info'

Please include the following above (all required):

[x] Link to your project: could be a code repository, a shared document, etc. See here
[x] Include your Mattermost handle (i.e. your username). If you do not have an account, please sign up here.
[x] Goals for the OHBM Brainhack: describe what you want to achieve during this brainhack. See here.
[x] Flesh out at least 2 "good first issues": those are tasks that do not require any prior knowledge about your project, could be defined as issues in a GitHub repository, or in a shared document, cf here.
[x] Skills: list skills that would be particularly suitable for your project. We ask you to include at least one non-coding skill, cf. here.
[x] Chat channel: A link to a chat channel that will be used during the OHBM Brainhack. This can be an existing channel or a new one. We recommend using the Brainhack space on mattermost, cf. here.
[x] Video channel: Please create a video channel that will be used during the OHBM Brainhack and share it in your chat channel above. This can be an existing channel or a new one. For instance a jitsi meet room, cf. here.
[x] Provide an image of your project for the OHBM brainhack website

You can also include information about (all optional):

[ ] Number of participants, cf. here
[ ] Twitter-size summary of your project pitch, cf. here
[ ] Set up a kanban board on your repository to better divide the work and keep track of things, cf here
[x] Project snippet for the OHBM Brainhack website, cf. here

We would like to think about how you will credit and onboard new members to your project. We recommend reading references from this section. If you'd like to share your thoughts with future project participants, you can include information about (recommended):

[ ] Specify how will you acknowledge contributions (e.g. listing members on a contributing page).
[ ] Provide links to onboarding documents if you have some.

welcome[bot] commented 4 years ago

Welcome Banner (Image: CC-BY license, The Turing Way Community, & Scriberia. Zenodo. http://doi.org/10.5281/zenodo.3332808) :tada: Welcome to the 2020 OHBM Hackathon! :tada: We're really excited to have your input on this repository and welcome your idea! :sparkling_heart: If you haven't done so already, please make sure you check out our Code of Conduct. Did you issue a new hackathon project? Please check if you have provided all relevant information and an image for the website.

nqueder commented 4 years ago

hi @ohbm/project-monitors My project is ready!

Remi-Gau commented 4 years ago

hey @nqueder :wave:

This looks good. :sparkles:

I think that our @ohbm/hack2020-monitors will have another look at that soon.

Already added some labels. Check through our list of issue labels if some other ones could be added.

Do you have an image for the website we could use?

Maybe the BIDS logo?

nqueder commented 4 years ago

Thanks! @Remi-Gau

An image for the website is attached below.

BIDS-Terms

Remi-Gau commented 4 years ago

Fantastic.

@DorienHuijser Can I let you handle this one? :wink:

jhlegarreta commented 4 years ago

@nqueder do you have a video channel for your project? Would you add that information to the mattermost channel, please? Thanks.

nqueder commented 4 years ago

@jhlegarreta of course! The link to my video channel has been added to the mattermost channel description.

complexbrains commented 4 years ago

Dear @nqueder would you mind adding 2 good first issues to your project and letting us know please. Once you are done with that, I will complete the project revision and your project will be ready to go! Thank you 🤗

nqueder commented 4 years ago

Hi @complexbrains ! My issue has been updated with two "good first issues" :)

complexbrains commented 4 years ago

Dear @nqueder Thank you so much for doing it so! Your project seems ready to go then! Welcome aboard! :hugs: 🎊

ohbm / hackathon2020