Skip to content

Conversation

@asiamustafah955
Copy link

@asiamustafah955 asiamustafah955 commented Jun 9, 2025

  • This comment contains a description of changes (with reason)
  • There is example tool output for tools in the https://github.com/MultiQC/test-data repository or attached to this PR
  • Code is tested and works locally (including with --strict flag)
  • Report sections have a description and help text (with self.add_section)
  • Each table column has a different colour scale to its neighbour, which relates to the data (e.g. if high numbers are bad, they're red)
  • Module does not do any significant computational work

This PR adds a new module called custom_csv to MultiQC.
Test data submitted as PR to MultiQC/test-data: MultiQC/test-data#351 — waiting for merge to fix failing tests.

Features:

  • Parses CSV files with "Metric Name" and "Metric Value" columns of flex files.
  • Associates metrics with sample names based on the file path.
  • Displays metrics in both the main report table and general stats.
  • Dynamically assigns a color scale to each table column for better visual distinction.

Usage:

Place your CSV files in the logs directory, ensuring they have headers:

  • Metric Name
  • Metric Value

Testing:

  • Works locally with the --strict flag.
  • Tested with sample data.

Files added/modified:

  • multiqc/modules/custom_csv/*

@asiamustafah955 asiamustafah955 changed the title Custom csv Custom csv module::new Jun 12, 2025
@asiamustafah955 asiamustafah955 changed the title Custom csv module::new 10x flex protocol module::new Jun 27, 2025
@asiamustafah955
Copy link
Author

@ewels, I was requesting if the label on my pull request could be adjusted to module:new. I requested a PR via a forked repository and therefore do not have the label gear.

@ewels ewels changed the title 10x flex protocol module::new New module: 10x flex protocol Jul 11, 2025
@asiamustafah955 asiamustafah955 changed the title New module: 10x flex protocol New module: 10x flex cellranger output protocol Jul 15, 2025
@pcm32
Copy link

pcm32 commented Sep 17, 2025

I think that this should be covered by #2861 - maybe you can help in finalising that one?

@asiamustafah955
Copy link
Author

asiamustafah955 commented Sep 17, 2025

I think that this should be covered by #2861 - maybe you can help in finalising that one?

The one I built is for .csv and the PR above is .html. Would you prefer CSV or .html results to be pulled?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants