Skip to content
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

New module: DIAMOND #1731

Merged
merged 8 commits into from Jan 7, 2023
Merged

New module: DIAMOND #1731

merged 8 commits into from Jan 7, 2023

Conversation

mjamy
Copy link
Contributor

@mjamy mjamy commented Jul 26, 2022

Adds module for DIAMOND.

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md has been updated
  • There is example tool output for tools in the https://github.com/ewels/MultiQC_TestData repository or attached to this PR: Add test data for diamond module test-data#237
  • Code is tested and works locally (including with --lint flag)
  • docs/README.md is updated with link to below
  • docs/modulename.md is created
  • Everything that can be represented with a plot instead of a table is a plot
  • Report sections have a description and help text (with self.add_section)
  • There aren't any huge tables with > 6 columns (explain reasoning if so)
  • Each table column has a different colour scale to its neighbour, which relates to the data (eg. if high numbers are bad, they're red)
  • Module does not do any significant computational work

Example output:
multiqc_report.zip

@mjamy mjamy marked this pull request as ready for review July 26, 2022 15:10
@ewels
Copy link
Member

ewels commented Jan 7, 2023

As with #1732 - I'm not sure that the bar plot adds anything, so I've removed it. Hope that's ok.

@@ -272,6 +272,9 @@ deeptools/plotPCAData:
deeptools/plotProfile:
contents: "bin labels"
num_lines: 1
diamond:
contents: "type: Diamond database"
fn: "*.log"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this module parse only the output from the --log flag? https://github.com/bbuchfink/diamond/wiki/3.-Command-line-options#general-options

In which case, is the filename always diamond.log? That's much easier (and faster) to search for..

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talked to @jfy133 and it looks like this is the case. I updated the module accordingly in a489954:

  • Update search pattern
  • Parse sample name from logged command instead of filename
  • Fall back to log directory name

Note that if you're manually renaming these log files in the taxprofiler pipeline, you'll need to tweak the search pattern in the pipeline MultiQC config file for it to still find the files. See docs.

@ewels ewels merged commit 176be17 into MultiQC:master Jan 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants