search

neurobagel / annotation_tool

https://annotate.neurobagel.org/
MIT License
3 stars 6 forks source link

Up to date source for a data dictionary #796

Open jsheunis opened 1 month ago

jsheunis commented 1 month ago

Hi everyone

(@surchs I'm reposting here just to have the issue provenance, in case someone has a similar question in the future)

I am working with some tools to generate user forms from schemas, and specifically want to see if I can generate a "Neurobagel data dictionary editor" (see for context: https://hub.datalad.org/datalink/tools/issues/2). For that I'd like to know whether this is the correct, updated and maintained version of the data dictionary schema: https://raw.githubusercontent.com/neurobagel/annotation_tool/refs/heads/main/assets/neurobagel_data_dictionary.schema.json?

surchs commented 1 month ago

Hey @jsheunis, apologies for the sluggish response to your original issue - just landed from a trip to Cali that messed up my schedule more than anticipated.

For that I'd like to know whether this is the correct, updated and maintained version of the data dictionary schema:

The short answer is yes.

The long answer is: yes, but for reasons we don't love. The model is specified here: https://github.com/neurobagel/bagel-cli/blob/ac4b2c7049e0d8601769c4a93f7974e47a64dc5a/bagel/dictionary_models.py but we haven't automated the JSON serialization and once we do, it'd probably be in a dedicated repo, maybe also with a transition to LinkML. Currently the jsonschema you linked is up to date.

jsheunis commented 1 month ago

No worries, thanks for following up. Good to know I've been working with the correct schema 👍