Visual reports: Reviewer Mode

[oesteban]

The idea is to have a switch button (probably javascript with bootstrap) to enable the reviewer mode. When in this mode, every reportlet shows a little widget to give a qualitative rating to the performance of fMRIPrep and maybe a text-box for comments.

In the end, these ratings can be downloaded (as a yaml [newlines] or a JSON file). Optionally, we could also push these to the Web-API.

The objective here is to avoid having an excel table open on a side when reviewing a dataset (bookkeeping errors, friction, etc.). Having anonymous reviews sent back to the Web-API will give us another picture of how good or bad fMRIPrep is behaving (these backtraces will include, for instance, the full version string)

I would like very much to hear your opinions @poldracklab/fmriprep-docusprint-leaders.

/cc @rwblair for your wisdom with bootstrap and past experience with MRIQC. Also because this idea will be implemented in niworkflows - for any prep tool.

Sideways overlaps #1524 and #1831

EDIT: it'd be nice to use cookies for when the user forgets to hit the "finish" button or wants to pause rating, close and reopen.

[rwblair]

Looking at the report generating code my initial thought is to put the javascript for the review boxes in niworkflows, and then have its inclusion in sub-reports/reportlets be defined in the fmriprep.yml configuration. @oesteban does this make sense or should I be looking else where?

[oesteban]

Agreed.

Base infrastructure

I think we need some little modifications to https://github.com/poldracklab/niworkflows/blob/ce82d7684ccde8b9c4046e9374b7266d0cbe2043/niworkflows/reports/report.tpl in order for adding the toggle button and some javascript to change the rating widgets from invisible to visible. In this template, we would also aggregate the "Download" button and the "Share" (post to web-api) button.

Finally, the cookie machinery would be nice to have - is also to be implemented in the template.

For the actual rating widgets

Then, I think just adding the html for the widgets here and possibly some other places - should be enough.