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

Warn user about incomplete annotation before downloading #637

Closed
2 of 3 tasks
Tracked by #59
surchs opened this issue Nov 14, 2023 · 1 comment · Fixed by #671
Closed
2 of 3 tasks
Tracked by #59

Warn user about incomplete annotation before downloading #637

surchs opened this issue Nov 14, 2023 · 1 comment · Fixed by #671
Assignees
Labels
documentation Changes only affect the documentation

Comments

@surchs
Copy link
Contributor

surchs commented Nov 14, 2023

At the moment, a user can make an incomplete annotation (i.e. leave out some required steps to make valid neurobagel .json) and our annotation tool will not say anything / emit any warning.

An example:

If

  • I label a column as "about" "Age"
  • I then never pick any "Transformation" for the "Age" columns (e.g. because I forget)

Then

  • the annotation tool will happily turn the "next" button green and let me proceed to the download page
  • and will let me download a .json that is not actually valid under our own schema (because it is missing the "Transformation" key). See also Make sure we create valid .json #597

I think we originally made that change because we thought a user might want to stop half-way through an annotation and pick it up later - and we shouldn't prevent them from downloading what they have until then. However, our tool isn't yet able to load our own annotations again. And even if we want to support this, we should definitely give a warning.

TODO:

  • validate the JSON we're about to give back to the user against our data dictionary json schema
  • Emit a warning on the download page or before if a user proceeds to download a .json file that isn't valid / user hasn't completed all annotation steps
  • propose a way to keep up to date on the data dictionary schema
@surchs surchs added the documentation Changes only affect the documentation label Nov 14, 2023
@surchs surchs added feat:improve flag:schedule Flag issue that should go on the roadmap or backlog. labels Nov 14, 2023
@surchs surchs moved this to Backlog in Neurobagel Nov 15, 2023
@surchs surchs removed the flag:schedule Flag issue that should go on the roadmap or backlog. label Nov 15, 2023
@surchs surchs moved this from Backlog to Specify - Active in Neurobagel Dec 4, 2023
@surchs surchs moved this from Specify - Active to Specify - Done in Neurobagel Dec 6, 2023
@alyssadai
Copy link
Contributor

@surchs surchs moved this from Specify - Done to Implement - Active in Neurobagel Dec 18, 2023
@surchs surchs self-assigned this Dec 18, 2023
@surchs surchs moved this from Implement - Active to Implement - Done in Neurobagel Jan 9, 2024
@rmanaem rmanaem moved this from Implement - Done to Review - Active in Neurobagel Jan 15, 2024
@github-project-automation github-project-automation bot moved this from Review - Active to Review - Done in Neurobagel Jan 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants