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

Add mmseqs2 taxonomy #343

Merged
merged 43 commits into from
Apr 2, 2024
Merged

Conversation

Darcy220606
Copy link
Contributor

@Darcy220606 Darcy220606 commented Feb 28, 2024

PR checklist

  • This PR adds teh taxonomic classification of contigs in a step prior enterig contig annotations.

  • This PR includes solving other issues and therefore closes issue Unify output of workflow summary tools #233 Reorder/rename hamronization summary columns #333 Include Contig taxonomic classification before going into the summary modules #318

  • For this PR to pass, it requires fixing a bug in mmseqs/createtsv module. UPDATE: FINALLY MERGED

  • This comment contains a description of changes (with reason).

  • If you've fixed a bug or added code that should be tested, add tests!

  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs

  • If necessary, also make a PR on the nf-core/funcscan branch on the nf-core/test-datasets repository.

  • Make sure your code lints (nf-core lint).

  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).

  • Usage Documentation in docs/usage.md is updated.

  • Output Documentation in docs/output.md is updated.

  • CHANGELOG.md is updated.

  • README.md is updated (including new tool citations and authors/contributors).

@Darcy220606 Darcy220606 self-assigned this Feb 28, 2024
@Darcy220606 Darcy220606 marked this pull request as draft February 28, 2024 12:29
Copy link

github-actions bot commented Feb 28, 2024

nf-core lint overall result: Passed ✅

Posted for pipeline commit d974f15

+| ✅ 236 tests passed       |+

✅ Tests passed:

Run details

  • nf-core/tools version 2.13.1
  • Run at 2024-04-02 14:29:56

Copy link
Collaborator

@jasmezz jasmezz left a comment

Choose a reason for hiding this comment

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

Nice work so far 🥳 I left a few comments and will wait for a ping from you when the workflow is ready to be reviewed.

nextflow.config Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
conf/modules.config Outdated Show resolved Hide resolved
@Darcy220606
Copy link
Contributor Author

The PR works locally, however for the test to pass it still requires mmseqs/createtsv module fix. Im currently working on the fix PR. Will ping you once its in :)

Darcy220606 and others added 5 commits March 12, 2024 23:48
Co-authored-by: Jasmin Frangenberg <73216762+jasmezz@users.noreply.github.com>
Co-authored-by: Jasmin Frangenberg <73216762+jasmezz@users.noreply.github.com>
Co-authored-by: Jasmin Frangenberg <73216762+jasmezz@users.noreply.github.com>
Co-authored-by: Jasmin Frangenberg <73216762+jasmezz@users.noreply.github.com>
@Darcy220606 Darcy220606 marked this pull request as ready for review March 12, 2024 23:01
@Darcy220606
Copy link
Contributor Author

pinging @jasmezz and @jfy133 and @louperelo for review. Pweez :)
So the PR :works locally on the AMPs, ARGS, and BGCs however it seems like its running out of resources for AMPs in the CI tests. Any ideas how to circumvent this? Also for linting it fails because of the template merges and gives warnings that many tools still need to be updated in funcscan.

Darcy220606 and others added 4 commits March 13, 2024 10:41
Co-authored-by: Jasmin Frangenberg <73216762+jasmezz@users.noreply.github.com>
Co-authored-by: Jasmin Frangenberg <73216762+jasmezz@users.noreply.github.com>
Copy link
Collaborator

@jasmezz jasmezz left a comment

Choose a reason for hiding this comment

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

Amazing work! 🤩
I think I didn't find logic errors really, just a lot of minor tweaks/formatting/wording.

CHANGELOG.md Outdated Show resolved Hide resolved
CITATIONS.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
bin/merge_taxonomy.py Show resolved Hide resolved
bin/merge_taxonomy.py Outdated Show resolved Hide resolved
workflows/funcscan.nf Outdated Show resolved Hide resolved
workflows/funcscan.nf Outdated Show resolved Hide resolved
workflows/funcscan.nf Outdated Show resolved Hide resolved
workflows/funcscan.nf Outdated Show resolved Hide resolved
workflows/funcscan.nf Show resolved Hide resolved
Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

I'm with @jasmezz here! Nextflow code/logic looks great, lots of minor structural/pedantic formatting thigns :D very good work @Darcy220606 !

CHANGELOG.md Outdated Show resolved Hide resolved
conf/modules.config Outdated Show resolved Hide resolved
conf/modules.config Outdated Show resolved Hide resolved
conf/test_bgc.config Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
nextflow.config Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
workflows/funcscan.nf Outdated Show resolved Hide resolved
Comment on lines 114 to 116
// The final subworkflow reports need taxonomic classification
// This can be either on NT or AA level depending on annotation
// NOTE: (AA tax. classification will be added only when its PR is merged - NOW - only on NT)
Copy link
Member

Choose a reason for hiding this comment

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

Maybe say TODO rather than NOTE so easier to identify in tfuture :)

@Darcy220606 Darcy220606 requested review from jasmezz and jfy133 March 23, 2024 12:38
Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Even closer!

conf/modules.config Show resolved Hide resolved
conf/modules.config Outdated Show resolved Hide resolved
conf/modules.config Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
docs/usage.md Show resolved Hide resolved
subworkflows/local/amp.nf Outdated Show resolved Hide resolved
subworkflows/local/taxa.nf Outdated Show resolved Hide resolved
Copy link
Collaborator

@jasmezz jasmezz left a comment

Choose a reason for hiding this comment

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

Seems like you skipped most of my tiny formatting and typo fixes from the last review. 👀 For those which you disagree with, please comment.

nextflow_schema.json Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CITATIONS.md Outdated Show resolved Hide resolved
bin/merge_taxonomy.py Outdated Show resolved Hide resolved
bin/merge_taxonomy.py Show resolved Hide resolved
workflows/funcscan.nf Outdated Show resolved Hide resolved
workflows/funcscan.nf Outdated Show resolved Hide resolved
workflows/funcscan.nf Outdated Show resolved Hide resolved
workflows/funcscan.nf Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Darcy220606
Copy link
Contributor Author

Darcy220606 commented Mar 27, 2024

Seems like you skipped most of my tiny formatting and typo fixes from the last review. 👀 For those which you disagree with, please comment.

@jasmezz Ive commited and pushed all your changes/suggestions from last week in this latest round, i dont know which version you were reviewing yesterday. Can you check again please ?

@jfy133
Copy link
Member

jfy133 commented Mar 27, 2024

@Darcy220606 did you also add my changes already, e.g. the license at the top of the scripts? They are also not displayed for me...?

@Darcy220606
Copy link
Contributor Author

Darcy220606 commented Mar 29, 2024

@jasmezz and @jasmezz your reviews are now all addressed (phew), please do have a look and let me know if theres something else that needs to be adjusted. @jasmezz please look at the 'files changed tab' this time ;)

Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

A few minor things, but otherwise I think we are there!! Well done @Darcy220606 !
Do you plan to make an offiical nf-core MMSEQs subworkflow later and replace it at a later date? If you want guidance I have a PR open you can replicate for a different subworkflow and can send you (I can't remember if you've done a nf-core subworkflow or not yet).

docs/output.md Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
@Darcy220606
Copy link
Contributor Author

Darcy220606 commented Apr 2, 2024

A few minor things, but otherwise I think we are there!! Well done @Darcy220606 ! Do you plan to make an offiical nf-core MMSEQs subworkflow later and replace it at a later date? If you want guidance I have a PR open you can replicate for a different subworkflow and can send you (I can't remember if you've done a nf-core subworkflow or not yet).

Yes @jfy133 , ill be making a nf-core subworkflow as we discussed. Its in the todo list :) Thanks ill have a look at the PR and use it as a template.

Copy link
Collaborator

@jasmezz jasmezz left a comment

Choose a reason for hiding this comment

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

Done! And very well done. I didn't find anything apart from typos/formatting or mini-updates in docs, so you can commit with [skip ci] if you want.

conf/test_taxonomy.config Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
subworkflows/local/taxa_class.nf Outdated Show resolved Hide resolved
conf/modules.config Outdated Show resolved Hide resolved
conf/modules.config Outdated Show resolved Hide resolved
conf/modules.config Outdated Show resolved Hide resolved
conf/modules.config Outdated Show resolved Hide resolved
@Darcy220606 Darcy220606 merged commit f4495a5 into nf-core:dev Apr 2, 2024
20 checks passed
@jasmezz jasmezz mentioned this pull request Jul 29, 2024
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants