ENH: New version of the rating widget

nipreps / mriqc

Automated Quality Control and visual reports for Quality Assessment of structural (T1w, T2w) and functional MRI of the brain

http://mriqc.readthedocs.io

Apache License 2.0

299 stars 132 forks source link

ENH: New version of the rating widget #1012

Closed oesteban closed 2 years ago

oesteban commented 2 years ago

Changes with this PR:

Updates Bootstrapjs to version 5.0.2
Updates jQuery to version 3.6.0
Updates some components of bootstrap for the new version
Convert the rating widget into a range slider allowing interval ratings.
Reduce the space the widget takes with an accordion
Make the rating widget invisible at the start
Add a field for comments and a slider for rater confidence
Add a timer, which is also reported within the JSON object.

Resolves: nipreps/mriqc#1007. Resolves: nipreps/mriqc#1008.

New look and feel: new-rating-widget

oesteban commented 2 years ago

@rwblair ratings are not integers on a Likert scale anymore, now we need to store floats - is that possible in the current MRIQCwebapi schema?

We probably want to add the collection of the elapsed time rating and the rater's confidence.

oesteban commented 2 years ago

Hey @oesteban, This looks great! What about extending the list of artifacts with some of my suggestion from issue nipreps/nireports#92 ? (cf discussion there)

Let's address that on a different PR.

rwblair commented 2 years ago

@oesteban looks like ratings coming in to web api are cast as strings to be as flexible as possible.

oesteban commented 2 years ago

There are two new fields we probably want to also submit:

rating time (the widget now has a timer to know how much time was spent on the report)
rater confidence

@oesteban looks like ratings coming in to web api are cast as strings to be as flexible as possible.

Does that mean that the API could also accept nonnumerical values? Do we know if someone has tried to push garbage in?

rwblair commented 2 years ago

Someone could post nonnumerical ratings, I have not looked to see if its been abused yet.

So the historic way of adding fields, as you have done, is embedding them in the comment field, ~~which is a hack to say the least~~ (*no need to be snippy its how we got away with allowing for easy expansion of rating widget). I need to think about how we can make this better and what all it would take. While still being backwards compatible.

rwblair commented 2 years ago

schema definition for ratings for context: https://github.com/nipreps/mriqcwebapi/blob/master/dockereve-master/eve-app/settings.py#L577

rwblair commented 2 years ago

My dump of ratings from 05/27 only contains single digit ratings from 1 to 4.