Add InterProScan to Pipeline and integrate in AMPcombi #428
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
Warning Newer version of the nf-core template is available. Your pipeline is using an old version of the nf-core template: 3.1.0. For more documentation on how to update your pipeline, please see the nf-core documentation and Synchronisation documentation. |
|
@nf-core-bot fix linting |
|
@nf-core-bot fix linting |
|
Also fixes issue number #434 |
jfy133
reviewed
Jan 10, 2025
jfy133
reviewed
Jan 22, 2025
| @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |||
|
|
|||
| - [#421](https://github.com/nf-core/funcscan/pull/421) Updated to nf-core template 3.0.2. (by @jfy133) | |||
| - [#427](https://github.com/nf-core/funcscan/pull/427) AMPcombi now can use multiple other databases for classifications. (by @darcy220606) | |||
| - [#428](https://github.com/nf-core/funcscan/pull/428) Added InterProScan annotation workflow to the pipeline. The results are coupled to AMPcombi final table. (by @darcy220606) | |||
There was a problem hiding this comment.
Suggested change
| - [#428](https://github.com/nf-core/funcscan/pull/428) Added InterProScan annotation workflow to the pipeline. The results are coupled to AMPcombi final table. (by @darcy220606) | |
| - [#428](https://github.com/nf-core/funcscan/pull/428) Added InterProScan protein annotation workflow to the pipeline. (by @darcy220606) |
jasmezz
requested changes
Feb 4, 2025
| withName: SEQKIT_SEQ_FILTER { | ||
| ext.prefix = { "${meta.id}_cleaned.faa" } | ||
| publishDir = [ | ||
| path: { "${params.outdir}/protein_annotation/interproscan/" }, |
There was a problem hiding this comment.
Are we sure we want the output in ${params.outdir}/protein_annotation/interproscan/ and not in ${params.outdir}/annotation/interproscan/? I'd prefer the latter, to have it all in one place regardless of DNA (pyrodigal etc.) or protein annotation (interproscan). I think it's more intuitive to search for any annotation results in a single folder.
If not, what do you think of renaming the annotation output folder to contig_annotation?
There was a problem hiding this comment.
The other annotation tools in the annotation workflow are annotating CDS which also can be proteins. I would leave the annotation workflow as is because thats the baseline annotation step of the pipeline. This annotation step is more of an accessory annotation to the pipeline if the user wants more information from diff DB and (1) its technically not correct protein_annotation because those are nnot necessary proteins and (2) the plan is that we add more to this workflow (e.g. the functional annotation of those CDS) so protein annotation will no longer be valid.
There was a problem hiding this comment.
The ouput im not sure if its a good idea to add it in the same folder because those are two diff workflows
There was a problem hiding this comment.
Okay. No strong opinion from my side. I still don't find the naming super intuitive, but it can be. Or why not cds_annotation for the CDS tools (prokka etc.) versus protein_annotation (interproscan)?
jasmezz
approved these changes
Feb 6, 2025
nextflow_schema.json
Outdated
| }, | ||
| "protein_annotation_interproscan_disableresidueannottsv": { | ||
| "type": "boolean", | ||
| "help_text": "This disables the addition of the annotations assigned according to the databases activated to the final `<sample>_interproscan.tsv` file. Turning this on will remove the annotations from the final table. It is not recommended to use this option, as it will cause a run failure because the format of the resulting files will no longer be adequate for integration in the final summary tables. Currently, only applicable for AMPcombi2. \n\nFor more information about this flag see the tool [documentation](https://interproscan-docs.readthedocs.io/en/latest/HowToRun.html).\n\n> Modifies tool parameter(s):\n> - InterProScan: `--enable-tsv-residue-annot`\n", |
There was a problem hiding this comment.
They cannot add it by ext.arg :D Everything that should be ext.arg is a pipeline parameter. If we don't offer it, the user cannot use it. That's why we add as much as necessary and leave out everything that shouldn't be touched (or is too irrelevant).
jasmezz
requested changes
Feb 6, 2025
There was a problem hiding this comment.
Things to do before merge:
- address the database update comments from my previous review since I tested the new interpro scan db version today (see comment here)
- either fix ampcombi/parsetables error as reported in AMP screening doesn't run when only a single tool is enabled #444 or outsource this to a different PR
|
jasmezz
approved these changes
Feb 10, 2025
nextflow_schema.json
Outdated
| }, | ||
| "protein_annotation_interproscan_disableresidueannottsv": { | ||
| "type": "boolean", | ||
| "help_text": "This disables the addition of the annotations assigned according to the databases activated to the final `<sample>_interproscan.tsv` file. Turning this on will remove the annotations from the final table. It is not recommended to use this option, as it will cause a run failure because the format of the resulting files will no longer be adequate for integration in the final summary tables. Currently, only applicable for AMPcombi2. \n\nFor more information about this flag see the tool [documentation](https://interproscan-docs.readthedocs.io/en/latest/HowToRun.html).\n\n> Modifies tool parameter(s):\n> - InterProScan: `--enable-tsv-residue-annot`\n", |
There was a problem hiding this comment.
We just discussed on Slack (here), that it might be safer to throw a warning in the AMP workflow, if the user changes this interproscan flag. Because we shouldn't expect them to read the whole params page or give them the pipeline-supported option to switch this flag and thereby crash the pipeline 🙈
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR checklist
This PR adds InterProScan to FUNCSCAN. It also integrates it into AMPcombi v2.0.1, which can parse its output as an optional flag.
This PR also closes issue #434
🚨 🚨 As interproscan requires a large database, i have not added it to any of the CI tests as that would require 4 hours for just downloading the database!!!!
👀 👀 👀 👀 👀 👀 Still TODO once AMPcombi 2.0.1 is updated in nf-core: DONE!!nf-core lint).nextflow run . -profile test,docker --outdir <OUTDIR>).nextflow run . -profile debug,test,docker --outdir <OUTDIR>).docs/usage.mdis updated.docs/output.mdis updated.CHANGELOG.mdis updated.README.mdis updated (including new tool citations and authors/contributors).