AI-SDC / ACRO

Tools for the Automatic Checking of Research Outputs. These are the tools for researchers to use as drop-in replacements for commands that produce outputs in Stata Python and R

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Prompt researcher to add information based on the output type and status

rpreen opened this issue · comments

Following the suggestion by @benbc to make handling exception requests an explicit part of the user experience, when an output fails the checks, we should prompt the researcher to add this information.

Probably the best place for this would be during finalise() because otherwise we risk annoying researchers that might want to just remove the output?

Should this be:

  • just added to the comments?
  • or have a special exception request field?

This is somewhat related to the concept of prompting the researcher for additional output-specific information for anything that we can't automatically extract - for example for a plot we might want to request the labels.

This is a really good idea.

  • Agree that during finalise() is the obvious place to do the prompt
  • Also agree that we should probably separate the description of the output from the 'exception request'