Skip to content

Commit 972f149

Browse files
committed
rename MetagRoot to metagRoot
1 parent 60f38c7 commit 972f149

7 files changed

Lines changed: 15 additions & 15 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
### `Added`
99

10-
- [#90](https://github.com/nf-core/proteinannotator/pull/90) - Added the option to download and use the latest `MetagRoot` HMM library (or use path to an existing one) for domain annotation. (by @angelphanth)
10+
- [#90](https://github.com/nf-core/proteinannotator/pull/90) - Added the option to download and use the latest `metagRoot` HMM library (or use path to an existing one) for domain annotation. (by @angelphanth)
1111
- [#87](https://github.com/nf-core/proteinannotator/pull/87) - Added the option to download and use the latest `NMPFams` HMM library (or use path to an existing one) for domain annotation. (by @npechl)
1212
- [#85](https://github.com/nf-core/proteinannotator/pull/85) - Added zenodo doi in `nextflow.config`. (by @vagkaratzas)
1313

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Generate input amino acid sequence statistics with ([`SeqFu`](https://github.com
3737
### Annotate sequences
3838

3939
1. Conserved domain annotation with ([`hmmer`](https://github.com/EddyRivasLab/hmmer/)) against databases
40-
such as [Pfam](https://ftp.ebi.ac.uk/pub/databases/Pfam/), [FunFam](https://download.cathdb.info/cath/releases/all-releases/), and [NMPFams and MetagRoot](https://pavlopoulos-lab.org/envofams/databases/hmmer/)
40+
such as [Pfam](https://ftp.ebi.ac.uk/pub/databases/Pfam/), [FunFam](https://download.cathdb.info/cath/releases/all-releases/), and [NMPFams and metagRoot](https://pavlopoulos-lab.org/envofams/databases/hmmer/)
4141
2. Functional annotation:
4242
- ([`InterProScan`](https://interproscan-docs.readthedocs.io/en/v5/)) a software tool used to analyze protein sequences by scanning them against the signatures of protein families, domains, and sites in the [InterPro](https://www.ebi.ac.uk/interpro/) database, helping to identify their functional characteristics.
4343
3. Predict secondary structure compositional features such as α-helices, β-strands and coils with ([`s4pred`](https://github.com/psipred/s4pred))

docs/output.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes d
1414
- [SeqFu](#seqfu) for input amino acid sequences quality control (QC)
1515
- [SeqKit](#seqkit) for preprocessing input amino acid sequences (i.e., gap removal, convert to upper case, validate, filter by length, replace special characters such as `/`, and remove duplicate sequences)
1616
- [Database download](#database-download) Optionally download selected databases for annotation.
17-
- [aria2](#aria2) - To optionally download the Pfam, FunFam, NMPFams, MetagRoot and/or InterProScan databases through the pipeline.
17+
- [aria2](#aria2) - To optionally download the Pfam, FunFam, NMPFams, metagRoot and/or InterProScan databases through the pipeline.
1818
- [Domain annotation](#domain-annotation) Annotate proteins with domains from established repositories.
19-
- [hmmer](#hmmer) - To optionally match the input sequence to known Pfam, FunFam, NMPFams and/or MetagRoot domains through `hmmer/hmmsearch`
19+
- [hmmer](#hmmer) - To optionally match the input sequence to known Pfam, FunFam, NMPFams and/or metagRoot domains through `hmmer/hmmsearch`
2020
- [Functional annotation](#functional-annotation) Annotate proteins with functional domains
2121
- [InterProScan](#Interproscan) - Search the InterProScan database for functional domains
2222
- [s4pred](#s4pred) - Predict secondary structures of sequences, producing amino acid level probabilities of forming an α-helix, a β-strand or a coil.
@@ -73,7 +73,7 @@ The `seqkit` module is used for initial preprocessing (i.e., gap removal, conver
7373
- `interproscan_test.tar.gz`: (optional) the downloaded InterProScan archive of member databases according to the optional user-provided url
7474
- `funfam-hmm3-v4_3_0*.lib.gz`: (optional) The latest (v4_3_0) full, or a minimal test, FunFam HMM database that can be downloaded through the pipeline.
7575
- `nmpfamsdb.hmm.gz`: (optional) The latest full, or a minimal test, NMPFams HMM database that can be downloaded through the pipeline.
76-
- `metagroot.hmm.gz`: (optional) The latest full, or a minimal test, MetagRoot HMM database that can be downloaded through the pipeline.
76+
- `metagroot.hmm.gz`: (optional) The latest full, or a minimal test, metagRoot HMM database that can be downloaded through the pipeline.
7777

7878
</details>
7979

docs/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
## Introduction
88

99
**nf-core/proteinannotator** is a bioinformatics pipeline that computes statistics and generates sequence-level annotations for amino acid sequences.
10-
It takes a protein FASTA file as input and performs conserved domain annotation (using Pfam, FunFam, NMPFams and MetagRoot HMM databases), functional annotation (using InterProScan), and secondary structure prediction (using s4pred).
10+
It takes a protein FASTA file as input and performs conserved domain annotation (using Pfam, FunFam, NMPFams and metagRoot HMM databases), functional annotation (using InterProScan), and secondary structure prediction (using s4pred).
1111
Optionally, paths to pre-downloaded databases can be provided to skip the automatic download steps and speed up repeated runs.
1212

1313
## Samplesheet input

nextflow_schema.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -296,19 +296,19 @@
296296
"skip_metagroot": {
297297
"type": "boolean",
298298
"fa_icon": "fas fa-ban",
299-
"description": "Skip the domain annotation with the MetagRoot database.",
300-
"help": "Skips the domain annotation of input sequence against a MetagRoot database."
299+
"description": "Skip the domain annotation with the metagRoot database.",
300+
"help": "Skips the domain annotation of input sequence against a metagRoot database."
301301
},
302302
"metagroot_db": {
303303
"type": "string",
304304
"format": "file-path",
305-
"description": "Path to an already installed MetagRoot HMM database (.hmm.gz).",
306-
"help_text": "If left null and skip_metagroot is false, the pipeline will start downloading the latest MetagRoot HMM library."
305+
"description": "Path to an already installed metagRoot HMM database (.hmm.gz).",
306+
"help_text": "If left null and skip_metagroot is false, the pipeline will start downloading the latest metagRoot HMM library."
307307
},
308308
"metagroot_latest_link": {
309309
"type": "string",
310310
"default": "https://pavlopoulos-lab.org/envofams/databases/hmmer/metagroot.hmm.gz",
311-
"description": "MetagRoot hosted link to the latest available MetagRoot HMM database file."
311+
"description": "metagRoot hosted link to the latest available metagRoot HMM database file."
312312
},
313313
"hmmsearch_evalue_cutoff": {
314314
"type": "number",

0 commit comments

Comments
 (0)