Skip to content

Elucidate which tools have run on sampled inputs in MultiQC report #122

@pontushojer

Description

@pontushojer

Description of feature

relates to #36

I think it will be important to make it clear to users of seqinspector which QC tools have been run on subsampled data or not. Furthermore, it should be clear which output metrics reflect subsampled data. For example, if seqinspector is run with FastQC on subsampled reads the read count ("Seqs" column) in the "General Stats" table at the top of the report reflects the subsampled data. We could hide these columns/plots for subsampled tools outputs, or possibly rename them, e.g. "Seqs (Sampled)", for clarity.

Things to consider:

  • Hide/rename columns/plot where subsampling could be misleading
  • Show relative metrics per default, e.g. enable "Percentage" for the FastqScreen - Mapped Reads plot.
  • Add comments to report sections, see example below.

Example section comments

Some logic could be added to update MultiQC configs to add a comment to sections for tools affected by subsampling.

multiqc_config.yaml

section_comments:
  fastqc: "NB! Sampling applied for this module."

Output example
Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions