Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add to template module that records selected pipeline parameters. #747

@jfy133

Description

@jfy133

Suggestion

Generate a params.json file containing all selected parameters for a given run, and display this at the end of MultiQC report alongside software_versions.

Use Case/Rationale

Inspired by the tower.nf 'configuration' display, provides a 'hard' copy of the exact parameters used in a given run in the MultiQC report (which would be acommon calling-point for post-run validation).

e.g. could be useful if presenting a MultiQC report in a meeting, and a collegue asks what parameter you used for XYZ - if you can't remember exactly - you can then can scroll down to the bottom of the report to see).

Possible Implmentation

Can exploit: nextflow-io/nextflow#1682 (comment)

i.e.

log.info("workflow params")
log.info("${params}")

to be parsed into a custom MultiQC params.json or TSV file, that is also added to the MultiQC config.

Notes from @ewels:

(same as how we do it with the launch tool)
But fine to put in MultiQC if it’s a table that becomes scrollable automatically when long I guess or something

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions