-
Notifications
You must be signed in to change notification settings - Fork 144
MultiQC Config update #841
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
Conversation
|
Warning Newer version of the nf-core template is available. Your pipeline is using an old version of the nf-core template: 3.2.1. For more documentation on how to update your pipeline, please see the nf-core documentation and Synchronisation documentation. |
These show where I think I need to add things.
|
I think this is ready for review. There is one caveat though, it turns out that when I made the MultiQC modules, I didn't have them add their columns to the general stats table (and BUSCO is the same way), so I am not sure if which is the best path for that: A) don't worry about it |
|
I think this is ready for review. There is one caveat though, it turns out that when I made the MultiQC modules, I didn't have them add their columns to the general stats table (and BUSCO is the same way), so I am not sure if which is the best path for that: A) don't worry about it Also, I tested it directly with MultiQC instead of nextflow/running the pipeline. Happy to do that, but it might take me a little while to get a machine set up for that. |
|
Hello, is there a reason you do not give |
|
@charles-plessy MultiQC appears to pull that data from the MultiQC module itself, so you only need to have it in the config if you want to more/different text. |
charles-plessy
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
|
Thanks for this @harper357 !
I would go for B or C, although I think in the case C would be best (as then you technically don't have to come back to the pipeline - we will just get the updates when we pull the next container) - unless MultiQC complains (in which case go with B)
You should just be able to run it in GitPod, then download the MultiQC report to check (except for GTDBTK currently) |
|
Question, since I don't immediately see this in the main workflow: do you also need to merge in the required outputs from [checkm, checkm2, gtdbtk] into the MultiQC input channel? |
Good point, I don't think these are being mixed in already indeed |
|
@prototaxites Whoops, I was even looking at that subworkflow and didn't notice that. I will fix that later today. @jfy133 Ok, I will do option C. I think it is just adding a single command for each of the modules in MultiQC, so it should be easy enough. |
|
Sorry this is taking so long. I had some trouble figuring out why non-BUSCO outputs weren't being seen by MultiQC, and then GTDB database is taking forever to download so I can't run the last test run yet. I should have it all wrapped up sometime tomorrow, though. |
Absolutely no rush, most of us are on holiday and/or conferencing! For GTDB we have a mini database you can maybe try, however with our current test data files it doesn't result in any hits. But if you want I can point you to it so at least you can try. Alternatively I'm back from my conference on Saturday so could also run with my copy of GTDB if it hasn't finished downloading for you then |
|
Ok, I ran the pipeline with All three worked as expected, adding the respective outputs to the MultiQC Report. @jfy133 I tried to use the mock GTDB-Tk database on nf-core/test-datasets (after manually updating the module to 2.4.1) but it ended up giving me errors about not finding a file |
|
@nf-core-bot fix linting |
dialvarezs
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The implementation looks good for me. Ran a full test with GTDBTk and CheckM2, and it's working as expected.
The only issue I see (but this is for the MultiQC module, not for this PR) is that displaying only the species can leave a lot of empty values. Maybe using the last non-empty taxon would be better.
@harper357 remember to update the changelog and add your name the contributors in the readme. With that ready, it would be ready to merge.
This is pretty simple PR (hopefully) to update the MultiQC config to include CheckM, checkm2, and GTDB.
See #739 .
PR checklist
nf-core pipelines lint).nextflow run . -profile test,docker --outdir <OUTDIR>).docs/output.mdis updated.CHANGELOG.mdis updated.README.mdis updated (including new tool citations and authors/contributors).