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: ganon #1935

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

New module: ganon #1935

wants to merge 14 commits into from

Conversation

jfy133
Copy link
Contributor

@jfy133 jfy133 commented Jun 13, 2023

Adds a module for ganon classify (note: the other sub commands produce similar-ish log files but are not informative)

  • 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:
  • 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

@jfy133
Copy link
Contributor Author

jfy133 commented Jun 13, 2023

Example report:

multiqc_report.zip

Also would be cool if @pirovc (author of ganon), would have a chance to have a look/leave comments if they have time/interest!

@pirovc
Copy link

pirovc commented Jul 3, 2023

Look good to me! Thanks. Later on statistics by taxonomic level can be included, but first I'd have to output them on the classify or report logs.

@vladsavelyev vladsavelyev changed the title Add ganon module New module: ganon Aug 25, 2023
@jfy133
Copy link
Contributor Author

jfy133 commented Sep 22, 2023

@ewels @vladsavelyev anything else I need to do here for a review?

@ewels
Copy link
Member

ewels commented Sep 23, 2023

We accept bribery in the form of biscuits 🍪 😋

We'll get to it soon, just working through the backlog 😊

@jfy133
Copy link
Contributor Author

jfy133 commented Sep 23, 2023

giphy.gif

@jfy133
Copy link
Contributor Author

jfy133 commented Jan 23, 2024

@pirovc I realise this may be out of date now since ganon 2.0 came out - to your knowledge would any changes be required (or any additional info?)

@jfy133
Copy link
Contributor Author

jfy133 commented Jan 25, 2024

@vladsavelyev @ewels I'm sure you would check thoroughly anyway, but I've attempted to add the software version and satisfy the new linting rules, but this is my first module with those, so it would be good to check those a bit more closely when you get to this.

@pirovc
Copy link

pirovc commented Jan 26, 2024

@pirovc I realise this may be out of date now since ganon 2.0 came out - to your knowledge would any changes be required (or any additional info?)

@jfy133 The STDOUT output in the v2 did not change from the late 1.X versions, so it should be alright.

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

4 participants