-
Notifications
You must be signed in to change notification settings - Fork 441
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
Update MultiQC to reject or report in error/help that HTML input is not valid #1538
Comments
We could:
|
As someone who was also confused by what FastQC output was needed for MultiQC |
The current MTS version still will accept, yet eventually error, when given HTML as input. The resulting log doesn't help the user to know what really went wrong or how to correct the inputs. It is great that the tool form label states "Raw Data" and it does match the FastQC dataset names to select. But filtering to exclude HTML would be better as @mblue9 states. Anyway, let's see if that is enough - I'll watch for user error reports due to this use-case. If nothing comes in, or at least fewer reported issues come in, I think we can close this out, unless there are future plans? Example from test history datasets 136 137 138 https://usegalaxy.org/u/jen/h/test-tools-prokka-unicycler-quast-multiqc
|
Users are reporting usage problems because they are inputting the HTML report from FastQC, not the Raw Data report, and sometimes both (!!).
Tool version 1.2.0: https://toolshed.g2.bx.psu.edu/view/iuc/multiqc/3bad335ccea9
Tutorials cover appropriate inputs here (and other places) but it doesn't seem to be enough: https://galaxyproject.org/tutorials/ngs/#assessing-data-quality
Could we consider these updates, with item 1 being the best (avoid this error case completely, making items 2 & 3 unnecessary, plus avoid wasting resources on a bad job that will eventually fail):
Trap when HTML input is given to the tool at runtime and aborting the submission with a red box warning near the input select stating "Inputs included HTML formatted reports. Input raw (plain text) reports instead." - OR - by filtering HTML datatypes out in the input select list of available datasets?
If item 1 above is not possible, improve the error message to state "Inputs included HTML formatted reports. Input raw (plain text) reports instead." ("Raw text" is the actual name given to the FastQC text version of the report - so just stating "plain text" is language that is not always interpreted by sci users well - and doesn't map to commonly input dataset names).
If item 1 above is not possible, state similar text as item 2 above in the help section of the tool form, example "Input raw (plain text) reports only. HTML reports will trigger a tool failure".
The text was updated successfully, but these errors were encountered: