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

Investigate schema and examples for the Nipoppy imaging bagel #344

Open
5 tasks done
Tracked by #342
surchs opened this issue Sep 24, 2024 · 2 comments · May be fixed by #349
Open
5 tasks done
Tracked by #342

Investigate schema and examples for the Nipoppy imaging bagel #344

surchs opened this issue Sep 24, 2024 · 2 comments · May be fixed by #349
Assignees
Labels
feat:add The first minimal viable change that implements a new functionality. type:feature Effort to deliver new features, feature changes & improvements

Comments

@surchs
Copy link
Contributor

surchs commented Sep 24, 2024

TODO

  • Figure out if Nipoppy already has a schema for the imaging bagel
  • Figure out what the near future imaging bagel schema is going to look like
  • Contribute a schema for the imaging bagel to nipoppy if wanted, then integrate / link this schema here (CLI repo). If nipoppy doesn't want a schema contributed, just create the schema here via pydantic
  • Find or create an example instance of a nipoppy imaging bagel and make it accessible here (i.e. by adding it to the neurobagel examples repo and updating our submodule of the neurobagel examples repo)
  • Add new prefix namespace for Nipoppy pipeline terms (allowed names & versions)

NOTES:

  • Nipoppy schema is in Pydantic v2, so we should probably see if we can use the jsonschema from their model instead for compatibility w/ our v1 CLI
@surchs surchs changed the title Add Pydantic model or other schema for the Nipoppy imaging bagel, if already exists Add schema and examples for the Nipoppy imaging bagel Sep 24, 2024
@surchs surchs added feat:add The first minimal viable change that implements a new functionality. type:feature Effort to deliver new features, feature changes & improvements labels Sep 24, 2024
@surchs
Copy link
Contributor Author

surchs commented Sep 24, 2024

Here is a link to the current latest nipoppy imaging bagel schema in the docs: https://nipoppy.readthedocs.io/en/latest/schemas/index.html#bagel-file

And here is the corresponding pydantic model from nipoppy: https://github.com/nipoppy/nipoppy/blob/756fb3532cc201986300ae2b0095429e179e5a9a/nipoppy/tabular/bagel.py

Finally, here is a currently open PR that has some proposed changes to the bagel schema: nipoppy/nipoppy#354

@alyssadai
Copy link
Contributor

Note: we probably also want to update the subject IDs from the Nipoppy example to be the same or a subset of IDs we're currently using in the reference example phenotypic data, so that we don't run into issues when testing the pheno command along with the new IDP command.

@alyssadai alyssadai changed the title Add schema and examples for the Nipoppy imaging bagel Investigate schema and examples for the Nipoppy imaging bagel Oct 1, 2024
@alyssadai alyssadai linked a pull request Oct 1, 2024 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat:add The first minimal viable change that implements a new functionality. type:feature Effort to deliver new features, feature changes & improvements
Projects
Status: Review - Active
Development

Successfully merging a pull request may close this issue.

2 participants