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

If a user provides an annotated dictionary, the app ignores it but keeps the annotations #677

Closed
3 tasks done
surchs opened this issue Jan 16, 2024 · 0 comments · Fixed by #715
Closed
3 tasks done
Assignees
Labels
bug:ux Unexpected and unintended behavior that is detrimental to the user experience. type:bug Defects in shipped code and fixes for those defects

Comments

@surchs
Copy link
Contributor

surchs commented Jan 16, 2024

We do not yet support uploading an already annotated data dictionary (see #601). However, if a user regardless uploads an already annotated data dictionary the app will happily take it. This leads to some very confusing states:

  • if I provide a completely annotated data dictionary 🤷 then the visual state of the app will tell me nothing is annotated yet, but my download will include all my existing annotations
  • if I provide an invalid data dictionary then again, the UI looks empty, but when I come to the download page and my data dictionary is validated, the validation will fail. Unless I guess what's going on, I cannot fix that

So in short: the state of the data dictionary in the app and the visual UI do not correspond to each other, and that's quite bad.
We have two options:

  1. Teach the app to load state from a data dictionary ([ENH] Let user upload an already annotated data dictionary #601)
  2. Put a big red warning on the first page that says: you cannot load a data dictionary with neurobagel annotations

I lean towards 2 because we will likely refactor this soon

TODO:

  • when existing data dictionary is loaded, strip away / rest the "Annotations" part
  • big warning on Home page near the "data dictionary" upload button to say "cannot reuse annotations"
  • test that existing annotations do not make it through the tool, e.g. no unintentional annotations
@surchs surchs added bug:ux Unexpected and unintended behavior that is detrimental to the user experience. type:bug Defects in shipped code and fixes for those defects flag:schedule Flag issue that should go on the roadmap or backlog. and removed flag:schedule Flag issue that should go on the roadmap or backlog. labels Jan 16, 2024
@surchs surchs self-assigned this Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug:ux Unexpected and unintended behavior that is detrimental to the user experience. type:bug Defects in shipped code and fixes for those defects
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant