Skip to content

Commit

Permalink
Merge pull request nf-core#338 from nf-core/bakta-meta-mode
Browse files Browse the repository at this point in the history
Add Bakta `meta` mode
  • Loading branch information
jasmezz authored Feb 12, 2024
2 parents fb84892 + 9a83cf1 commit 11719fa
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 3 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [#322](https://github.com/nf-core/funcscan/pull/322) Updated all modules: introduce environment.yml files. (by @jasmezz)
- [#324](https://github.com/nf-core/funcscan/pull/324) Removed separate DeepARG test profile because database download is now stable. (by @jasmezz)
- [#332](https://github.com/nf-core/funcscan/pull/332) & [#327](https://github.com/nf-core/funcscan/pull/327) Merged pipeline template of nf-core/tools version 2.12.1 (by @jfy133, @jasmezz)
- [#338](https://github.com/nf-core/funcscan/pull/338) Set `--meta` parameter to default for Bakta, with singlemode optional. (by @jasmezz)

### `Fixed`

Expand Down
1 change: 1 addition & 0 deletions conf/modules.config
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ process {
saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
]
ext.args = [
params.annotation_bakta_singlemode ? '' : '--meta',
"--min-contig-length ${params.annotation_bakta_mincontiglen}",
"--translation-table ${params.annotation_bakta_translationtable}",
"--gram ${params.annotation_bakta_gram}",
Expand Down
1 change: 1 addition & 0 deletions nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ params {

annotation_bakta_db_localpath = null
annotation_bakta_db_downloadtype = 'full'
annotation_bakta_singlemode = false
annotation_bakta_mincontiglen = 1
annotation_bakta_translationtable = 11
annotation_bakta_gram = '?'
Expand Down
16 changes: 13 additions & 3 deletions nextflow_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,16 @@
"description": "Download full or light version of the Bakta database if not supplying own database.",
"help_text": "If you want the pipeline to download the Bakta database for you, you can choose between the full (33.1 GB) and light (1.3 GB) version. The full version is generally recommended for best annotation results, because it contains all of these:\n\n- UPS: unique protein sequences identified via length and MD5 hash digests (100% coverage & 100% sequence identity)\n- IPS: identical protein sequences comprising seeds of UniProt's UniRef100 protein sequence clusters\n- PSC: protein sequences clusters comprising seeds of UniProt's UniRef90 protein sequence clusters\n- PSCC: protein sequences clusters of clusters comprising annotations of UniProt's UniRef50 protein sequence clusters\n\nIf download bandwidth, storage, memory, or run duration requirements become an issue, go for the light version (which only contains PSCCs) by modifying the `annotation_bakta_db_downloadtype` flag.\nMore details can be found in the [documentation](https://github.com/oschwengers/bakta#database)\n\n> Modifies tool parameter(s):\n> - BAKTA_DBDOWNLOAD: `--type`",
"fa_icon": "fas fa-database",
"enum": ["full", "light"]
"enum": ["full", "light"],
"default": "full"
},
"annotation_bakta_singlemode": {
"type": "boolean",
"description": "Use the default genome-length optimised mode (rather than the metagenome mode).",
"help_text": "By default, Bakta's --meta mode is used in the pipeline to improve the gene prediction of highly fragmented metagenomes.\n\nBy specifying this parameter Bakta will instead use its default mode that is optimised for singular 'complete' genome sequences.\n\nMore details can be found in the [documentation](https://github.com/oschwengers/bakta/blob/main/README.md#usage).\n\n> Modifies tool parameter(s):\n> - BAKTA: `--meta`",
"minimum": 1,
"maximum": 25,
"fa_icon": "fas fa-dna"
},
"annotation_bakta_mincontiglen": {
"type": "integer",
Expand Down Expand Up @@ -236,7 +245,7 @@
"annotation_prokka_singlemode": {
"type": "boolean",
"description": "Use the default genome-length optimised mode (rather than the metagenome mode).",
"help_text": "By default, Prokka's --metagenome mode is used in the pipeline to improve the gene prediction of highly fragmented metagenomes.\n\nBy specifying this parameter Prokka will instead use it's default mode that is optimised for singular 'complete' genome sequences.\n\nFor more information, please check Prokka [documentation](https://github.com/tseemann/prokka).\n\n> Modifies tool parameter(s):\n> - Prokka: `--metagenome`",
"help_text": "By default, Prokka's --metagenome mode is used in the pipeline to improve the gene prediction of highly fragmented metagenomes.\n\nBy specifying this parameter Prokka will instead use its default mode that is optimised for singular 'complete' genome sequences.\n\nFor more information, please check Prokka [documentation](https://github.com/tseemann/prokka).\n\n> Modifies tool parameter(s):\n> - Prokka: `--metagenome`",
"fa_icon": "fas fa-braille"
},
"annotation_prokka_rawproduct": {
Expand Down Expand Up @@ -301,7 +310,8 @@
"type": "boolean",
"fa_icon": "far fa-check-circle",
"description": "Force contig name to Genbank/ENA/DDJB naming rules.",
"help_text": "Force the contig headers to conform to the Genbank/ENA/DDJB contig header standards. This is activated in combination with `--centre [X]` when contig headers supplied by the user are non-conforming and therefore need to be renamed before Prokka can start annotation. This flag activates `--genes --mincontiglen 200`. For more information please check Prokka [documentation](https://github.com/tseemann/prokka). \n\n> Modifies tool parameter(s):\n> - Prokka: `--compliant`"
"help_text": "Force the contig headers to conform to the Genbank/ENA/DDJB contig header standards. This is activated in combination with `--centre [X]` when contig headers supplied by the user are non-conforming and therefore need to be renamed before Prokka can start annotation. This flag activates `--genes --mincontiglen 200`. For more information please check Prokka [documentation](https://github.com/tseemann/prokka). \n\n> Modifies tool parameter(s):\n> - Prokka: `--compliant`",
"default": true
},
"annotation_prokka_addgenes": {
"type": "boolean",
Expand Down

0 comments on commit 11719fa

Please sign in to comment.