Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.0%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: gene2dis
  • License: mit
  • Language: Nextflow
  • Default Branch: main
  • Size: 2.16 MB
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 1
  • Open Issues: 6
  • Releases: 0
Created over 3 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License Citation

README.md

Introduction

Microbial Genome Analysis Pipeline

MGAP is a bioinformatics best-practice analysis pipeline for Microbial Genome Analysis Pipeline.

The pipeline is built using Nextflow, 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 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 in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!

This pipeline is divided in two main steps, genome assembly and genome annotation.

Genome assembly

The genome assembly workflow allows the read processing and assembly of Illumina and Oxford Nanopore data. For each sequencing technology, a different set of tools are used:

Illumina assembly

  1. Read QC, clean, and filter reads. (FastP)
  2. If requested, calculate coverage of genome (Mash) and reduce coverage (Seqtk.
  3. If requested, check the reads with Kraken2 against a standard (small) database to evaluate possible contaminations (Kraken2)
  4. Genome assembly with SPADES

ONT reads

  1. Read QC with NANOQ
  2. Adapter removal with PORECHOP_ABI
  3. If requested, calculate coverage of genome (Mash) and reduce coverage (Seqtk
  4. Genome assembly using FLYE
  5. Genome polishing using MEDAKA
  6. Genome reorientation using Dnaapler (skipped at the moment, due to errors when the markers are not present)

Genome annotation

With the assembled genome, the annotation steps include:

  1. MLST analysis (MLST)
  2. Annotation (BAKTA)
  3. Antibiotic resistance prediction using AMRFinderPlus. If the organism is on the list provided by AMRFinderPlus, also point mutations are evaluated (AMRFinderPLus)
  4. Prophage and plasmid search using Genomad
  5. For Klebsiella, evaluation of the genome using Kleborate
  6. For S. aureus, SCCmec classification using staphophia-sccmec

Quick Start

  1. Install Nextflow (>=22.10.1)

  2. Install any of Docker, Singularity (you can follow this tutorial), Podman, Shifter or Charliecloud for full pipeline reproducibility (you can use Conda both to install Nextflow itself and also to manage software within pipelines. Please only use it within pipelines as a last resort; see docs).

Currently the pipeline has been tested with Docker, but should work without issues with Singularity or Conda.

  1. Download the pipeline, either cloning the repository or downloading the zip file

Running the pipeline

Sample sheet file

First you need to create a Samplesheet file, that contain the name of the samples and the location of the reads. This is an example of this file:

Illumina reads

sample,fastq_1,fastq_2 SCL10095,/home/jugalde/germlab/data/S190_R1.fastq.gz,/home/jugalde/germlab/data/S190_R2.fastq.gz

The file always has to include the header sample,fastq_1,fastq_2

ONT reads

sample,fastq_1 C19013,/home/jugalde/germlab/data/C19013.fastq.gz

The file always has to include the header sample,fastq_1,fastq_2

Pipeline parameters

The file nextflow.config contains all the parameteres used by the pipeline, including path to database files. Currently the path work in our server (Arrakis), but if you are running elsewhere, these need to be updated. Later a section on how to download and prepare the DBs needed for the analysis, will be added to this Readme file.

Starting the pipeline

Once you have everything ready, you can run the pipeline by calling the name of the repository, and adding the appropiate parameters. For example:

bash nextflow run gene2dis-mgap --input <SAMPLESHEET> --outdir <OUTDIR> -profile docker -seq_type illumina|ont

Here the parameters are: - gene2dis-mgap: The name of the repository. This could be the path to a location on the computer (e.g. /home/jugalde/pipelines/gene2dis-mgap). - --input: The samplesheet file - --outdir: The output directory for the output of the pipeline - -profile: either docker or conda (not tested yet) - --seq_type: sequencing technology used, either illumina or ont

*Notice that the pipeline parameters have two dashes (--), while parameters that are for nextflow only have one (-).

Credits

gene2dis/mgap was originally written by the Microbial Data Science Lab, Center for Bioinformatics and Integrative Biology, Universidad Andres Bello. Its development was led by Juan A. Ugalde

We thank the following people for their extensive assistance in the development of this pipeline:

  • Juan A. Ugalde

Contributions and Support

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

Citations

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

This pipeline uses code and infrastructure developed and maintained by the nf-core community, reused here under the MIT license.

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.

Owner

  • Name: Genomic in Epidemiology in Emergent Diseases
  • Login: gene2dis
  • Kind: organization
  • Location: Chile

Genomic in Epidemiology in Emergent Diseases, ATE220061

Citation (CITATIONS.md)

# gene2dis/mgap: Citations

## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)

> Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x. PubMed PMID: 32055031.

## [Nextflow](https://pubmed.ncbi.nlm.nih.gov/28398311/)

> Di Tommaso P, Chatzou M, Floden EW, Barja PP, Palumbo E, Notredame C. Nextflow enables reproducible computational workflows. Nat Biotechnol. 2017 Apr 11;35(4):316-319. doi: 10.1038/nbt.3820. PubMed PMID: 28398311.

## Pipeline tools

- [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/)

- [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.

## Software packaging/containerisation tools

- [Anaconda](https://anaconda.com)

  > Anaconda Software Distribution. Computer software. Vers. 2-2.4.0. Anaconda, Nov. 2016. Web.

- [Bioconda](https://pubmed.ncbi.nlm.nih.gov/29967506/)

  > Grüning B, Dale R, Sjödin A, Chapman BA, Rowe J, Tomkins-Tinch CH, Valieris R, Köster J; Bioconda Team. Bioconda: sustainable and comprehensive software distribution for the life sciences. Nat Methods. 2018 Jul;15(7):475-476. doi: 10.1038/s41592-018-0046-7. PubMed PMID: 29967506.

- [BioContainers](https://pubmed.ncbi.nlm.nih.gov/28379341/)

  > da Veiga Leprevost F, Grüning B, Aflitos SA, Röst HL, Uszkoreit J, Barsnes H, Vaudel M, Moreno P, Gatto L, Weber J, Bai M, Jimenez RC, Sachsenberg T, Pfeuffer J, Alvarez RV, Griss J, Nesvizhskii AI, Perez-Riverol Y. BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics. 2017 Aug 15;33(16):2580-2582. doi: 10.1093/bioinformatics/btx192. PubMed PMID: 28379341; PubMed Central PMCID: PMC5870671.

- [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241)

- [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/)
  > Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.

GitHub Events

Total
  • Issues event: 5
  • Watch event: 2
  • Push event: 7
  • Pull request event: 6
  • Create event: 1
Last Year
  • Issues event: 5
  • Watch event: 2
  • Push event: 7
  • Pull request event: 6
  • Create event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 3
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ncansan (3)
Pull Request Authors
  • juanu (2)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Dependencies

modules/local/amrfinderplus/meta.yml cpan
modules/local/genomad/meta.yml cpan
modules/local/kleborate/meta.yml cpan
modules/local/mash/sketch/meta.yml cpan
modules/local/spades/meta.yml cpan
modules/local/unicycler/meta.yml cpan
modules/nf-core/antismash/antismashlite/meta.yml cpan
modules/nf-core/bakta/bakta/meta.yml cpan
modules/nf-core/bracken/bracken/meta.yml cpan
modules/nf-core/custom/dumpsoftwareversions/meta.yml cpan
modules/nf-core/fastp/meta.yml cpan
modules/nf-core/gtdbtk/classifywf/meta.yml cpan
modules/nf-core/kraken2/kraken2/meta.yml cpan
modules/nf-core/macrel/contigs/meta.yml cpan
modules/nf-core/mlst/meta.yml cpan
modules/nf-core/multiqc/meta.yml cpan
modules/nf-core/quast/meta.yml cpan
modules/nf-core/seqtk/sample/meta.yml cpan
modules/nf-core/staphopiasccmec/meta.yml cpan
pyproject.toml pypi