nf-core / tools

Python package with helper tools for the nf-core community.
https://nf-co.re
MIT License
241 stars 190 forks source link

MultiQC results not cacheable #3110

Open apeltzer opened 2 months ago

apeltzer commented 2 months ago

Description of the bug

Within the demux pipeline, we observe that MultiQC is never cached and thus always reexecuted, see also https://github.com/nf-core/demultiplex/issues/233 for a full discussion. Some pipelines configure in the conf/modules.config that MultiQC should not be cached at all (by setting caching = false), whereas this is not desired and thus also not configured in demultiplex as such.

The main issue boils down to some files being created using the official nf-core tools template tooling, e.g. workflow_summary_mqc.yaml and methods_description_mqc.yaml by changing whats ingested into these two YAML files as well as the sorting of these files / content that is in these files. The latter can be addressed by some channel magic, the former is more difficult to address and should thus be tackled probably here within the template and then auto-fixed via a template merge across multiple pipelines.

If people then actively turn off caching thats their choice - but at the moment its broken for those who would like not to re-run steps with MultiQC involved unfortunately :)

Command used and terminal output

nf-core run nf-core/demultiplexing -profile test,docker --outdir fancy_dir

System information

Doesnt really matter here