Merge pull request #161 from nf-core/first_release_review

First release review

Author: luisas

.github/CONTRIBUTING.md

@@ -24,6 +24,10 @@ If you'd like to write some code for nf-core/multiplesequencealign, the standard
 
 If you're not used to this workflow with git, you can start with some [docs from GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests) or even their [excellent `git` resources](https://try.github.io/).
 
+:::note
+! There is an extended documentation for adding specific module types into this pipeline at [extending](../docs/extending.md).
+:::
+
 ## Tests
 
 You have the option to test your changes locally by running the pipeline. For receiving warnings about process selectors and other `debug` information, it is recommended to use the debug profile. Execute all the tests with the following command:

.nf-core.yml

@@ -2,4 +2,7 @@ repository_type: pipeline
 nf_core_version: "2.14.1"
 lint:
   multiqc_config: False
-  files_exist: conf/igenomes.config
+  files_exist:
+    - conf/igenomes.config
+  files_unchanged:
+    - .github/CONTRIBUTING.md

CHANGELOG.md

@@ -3,7 +3,7 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 1.0.0 - Somorrostro
+## [1.0.0 - Somorrostro](https://github.com/nf-core/multiplesequencealign/releases/tag/1.0.0)
 
 Somorrostro is a beach in Barcelona.
 

CITATIONS.md

@@ -40,6 +40,10 @@
 
   > Katoh K, Misawa K, Kuma K, Miyata T. MAFFT: a novel method for rapid multiple sequence alignment based on fast Fourier transform. Nucleic Acids Res. 2002 Jul 15;30(14):3059-66. doi: 10.1093/nar/gkf436. PMID: 12136088; PMCID: PMC135756.
 
+- [MAGUS](https://pubmed.ncbi.nlm.nih.gov/33252662/)
+
+  > Smirnov V, Warnow T. MAGUS: Multiple sequence Alignment using Graph clUStering. Bioinformatics. 2021 Jul 19;37(12):1666-1672. doi: 10.1093/bioinformatics/btaa992. PMID: 33252662; PMCID: PMC8289385.
+
 - [MultiQC](https://pubmed.ncbi.nlm.nih.gov/27312411/)
 
   > Ewels P, Magnusson M, Lundin S, Käller M. MultiQC: summarize analysis results for multiple tools and samples in a single report. Bioinformatics. 2016 Oct 1;32(19):3047-8. doi: 10.1093/bioinformatics/btw354. Epub 2016 Jun 16. PubMed PMID: 27312411; PubMed Central PMCID: PMC5039924.

README.md

@@ -21,9 +21,13 @@
 
 **nf-core/multiplesequencealign** is a pipeline to deploy and systematically evaluate Multiple Sequence Alignment (MSA) methods.
 
+The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The [Nextflow DSL2](https://www.nextflow.io/docs/latest/dsl2.html) implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from [nf-core/modules](https://github.com/nf-core/modules) in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!
+
+On release, automated continuous integration tests run the pipeline on a full-sized dataset on the AWS cloud infrastructure. This ensures that the pipeline runs on AWS, has sensible resource allocation defaults set to run on real-world datasets, and permits the persistent storage of results to benchmark between pipeline releases and other analysis sources.The results obtained from the full-sized test can be viewed on the [nf-core website](https://nf-co.re/proteinfold/results).
+
 ![Alt text](docs/images/nf-core-msa_metro_map.png?raw=true "nf-core-msa metro map")
 
-In a nutshell, the pipeline performs the following steps:
+The pipeline performs the following steps:
 
 1. **Input files summary**: (Optional) computation of summary statistics on the input files, such as the average sequence similarity across the input sequences, their length, plddt extraction if available.
 
@@ -34,8 +38,9 @@ In a nutshell, the pipeline performs the following steps:
 
 ## Usage
 
-> [!NOTE]
-> If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline) with `-profile test` before running the workflow on actual data.
+:::note
+If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline) with `-profile test` before running the workflow on actual data.
+:::
 
 #### 1. SAMPLESHEET
 
@@ -52,8 +57,9 @@ toxin,toxin.fa,toxin-ref.fa,toxin_structures,toxin_template.txt
 
 Each row represents a set of sequences (in this case the seatoxin and toxin protein families) to be aligned and the associated (if available) reference alignments and dependency files (this can be anything from protein structure or any other information you would want to use in your favourite MSA tool).
 
-> [!NOTE]
-> The only required input is the id column and either fasta or dependencies.
+:::note
+The only required input is the id column and either fasta or dependencies.
+:::
 
 #### 2. TOOLSHEET
 
@@ -72,8 +78,9 @@ FAMSA, -gt upgma -medoidtree, FAMSA,
 FAMSA,,REGRESSIVE,
 ```
 
-> [!NOTE]
-> The only required input is aligner.
+:::note
+The only required input is aligner.
+:::
 
 #### 3. RUN THE PIPELINE
 
@@ -87,9 +94,10 @@ nextflow run nf-core/multiplesequencealign \
    --outdir outdir
 ```
 
-> [!WARNING]
-> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;
-> see [docs](https://nf-co.re/usage/configuration#custom-configuration-files).
+:::warning
+Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;
+see [docs](https://nf-co.re/usage/configuration#custom-configuration-files).
+:::
 
 For more details and further functionality, please refer to the [usage documentation](https://nf-co.re/multiplesequencealign/usage) and the [parameter documentation](https://nf-co.re/multiplesequencealign/parameters).
 

assets/adaptivecard.json

@@ -17,7 +17,7 @@
                         "size": "Large",
                         "weight": "Bolder",
                         "color": "<% if (success) { %>Good<% } else { %>Attention<%} %>",
-                        "text": "nf-core/multiplesequencealign v${version} - ${runName}",
+                        "text": "nf-core/multiplesequencealign ${version} - ${runName}",
                         "wrap": true
                     },
                     {

assets/multiqc_config.yml

@@ -1,7 +1,7 @@
 report_comment: >
   This report has been generated by the <a href="https://github.com/nf-core/multiplesequencealign/releases/tag/1.0.0" target="_blank">nf-core/multiplesequencealign</a>
   analysis pipeline. For information about how to interpret these results, please see the
-  <a href="https://nf-co.re/multiplesequencealign/0.1.0dev/docs/output" target="_blank">documentation</a>.
+  <a href="https://nf-co.re/multiplesequencealign/1.0.0/docs/output" target="_blank">documentation</a>.
 report_section_order:
   "nf-core-multiplesequencealign-methods-description":
     order: -1000

assets/schema_tools.json

@@ -9,6 +9,7 @@
         "properties": {
             "tree": {
                 "type": "string",
+                "pattern": "^\\S+$",
                 "errorMessage": "tree name cannot contain spaces",
                 "meta": ["tree"]
             },
@@ -19,6 +20,7 @@
             "aligner": {
                 "type": "string",
                 "meta": ["aligner"],
+                "pattern": "^\\S+$",
                 "errorMessage": "align name must be provided and cannot contain spaces"
             },
             "args_aligner": {

docs/extending.md

@@ -9,6 +9,8 @@ This pipeline is extensible, allowing the incorporation of new methods for assem
 - The [nf-test documentation](https://code.askimed.com/nf-test/docs/getting-started/)
 - The [nf-core slack](https://nf-co.re/join), particularly the [multiplesequencealign channel](https://nfcore.slack.com/archives/C05LZ7EAYGK). Feel free to reach out!
 
+Please also check the [contribution guidelines](../.github/CONTRIBUTING.md).
+
 ## Adding an aligner
 
 These steps will guide you to include a new MSA tool into the pipeline. Once done, this will allow you to systematically deploy and benchmark your tool against all others included in the pipeline. You are also welcome to contribute back to the pipeline if you wish.