README.md

Introduction

nf-core/multiplesequencealign is a pipeline to deploy and systematically evaluate Multiple Sequence Alignment (MSA) methods.

In a nutshell, 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, among others.
2. Guide Tree: (Optional) Renders a guide tree with a chosen tool (list available in usage). Some aligners use guide trees to define the order in which the sequences are aligned.
3. Align: (Required) Aligns the sequences with a chosen tool (list available in usage).
4. Evaluate: (Optional) Evaluates the generated alignments with different metrics: Sum Of Pairs (SoP), Total Column score (TC), iRMSD, Total Consistency Score (TCS), etc.
5. Report: Reports the collected information of the runs in a Shiny app and a summary table in MultiQC.

Usage

Note

If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with -profile test before running the workflow on actual data.

1. SAMPLESHEET

The sample sheet defines the input data that the pipeline will process. It should look like this:

samplesheet.csv:

id,fasta,reference,structures,template
seatoxin,seatoxin.fa,seatoxin-ref.fa,seatoxin_structures,seatoxin_template.txt
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 protein structure files.

Note

The only required input is the id column and either fasta or structures.

2. TOOLSHEET

Each line of the toolsheet defines a combination of guide tree and multiple sequence aligner to run with the respective arguments to be used.

It should look at follows:

toolsheet.csv:

tree,args_tree,aligner,args_aligner,
FAMSA, -gt upgma -medoidtree, FAMSA,
, ,TCOFFEE,
FAMSA,,REGRESSIVE,

Note

The only required input is aligner.

3. RUN THE PIPELINE

Now, you can run the pipeline using:

nextflow run nf-core/multiplesequencealign \
   -profile test \
   --input samplesheet.csv \
   --tools toolsheet.csv \
   --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.

For more details and further functionality, please refer to the usage documentation and the parameter documentation.

Pipeline output

To see the results of an example test run with a full size dataset refer to the results tab on the nf-core website pipeline page. For more details about the output files and reports, please refer to the output documentation.

Extending the pipeline

For details on how to add your favourite guide tree, MSA or evaluation step in nf-core/multiplesequencealign please refer to the extending documentation.

Credits

nf-core/multiplesequencealign was originally written by Luisa Santus (@luisas) and Jose Espinosa-Carrasco (@JoseEspinosa) from The Comparative Bioinformatics Group at The Centre for Genomic Regulation, Spain.

The following people have significantly contributed to the development of the pipeline and its modules: Leon Rauschning (@lrauschning), Alessio Vignoli (@alessiovignoli) and Leila Mansouri (@l-mansouri).

Contributions and Support

If you would like to contribute to this pipeline, please see the contributing guidelines.

For further information or help, don't hesitate to get in touch on the Slack #multiplesequencealign channel (you can join with this invite).

Citations

An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.

You can cite the nf-core publication as follows:

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.