genomeqc

Compare the quality of multiple genomes, along with their annotations.

https://github.com/nf-core/genomeqc

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 10 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary

Keywords

bioinformatics genome-assembly-evaluation genomics nextflow nf-core phylogenetic-trees pipeline quality-control
Last synced: 6 months ago · JSON representation ·

Repository

Compare the quality of multiple genomes, along with their annotations.

Basic Info
  • Host: GitHub
  • Owner: nf-core
  • License: mit
  • Language: Nextflow
  • Default Branch: dev
  • Homepage: https://nf-co.re/genomeqc
  • Size: 2.74 MB
Statistics
  • Stars: 15
  • Watchers: 35
  • Forks: 16
  • Open Issues: 58
  • Releases: 0
Topics
bioinformatics genome-assembly-evaluation genomics nextflow nf-core phylogenetic-trees pipeline quality-control
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Citation

README.md

nf-core/genomeqc nf-core/genomeqc

GitHub Actions CI Status GitHub Actions Linting StatusCite with Zenodo nf-test

Nextflow run with conda run with docker run with singularity Launch on Seqera Platform

Introduction

nf-core/genomeqc is a bioinformatics pipeline that compares the quality of multiple genomes, along with their annotations.

The pipeline takes a list of genomes and annotations (from local files or ncbi accessions), and runs commonly used tools to assess their quality.

Depending on the provided inputs, there are two ways this pipeline can run: 1. Genome only (minmal run, only fasta files are supplied) 2. Genome and Annotation (both fasta and gtf/gff files are supplied)

pipeline_diagram

2. Genome Only: 1. Downloads the genome files from NCBI: NCBI genome download - Or you provide your own genomes 2. Describes genome assembly: 1. BUSCO: Evaluates genome completeness based on single copy markers. 2. BUSCO Ideogram: Plots the location of markers on the assembly. 3. tidk (optional): Indetfies and visualises telomeric repeats. 3. QUAST: Computes contiguity and integrity statistics: N50, N90, GC%, number of sequences. 3. Summary with MultiQC.

1. Genome and Annotation: 1. Downloads the genome and gene annotation files from NCBI: NCBI genome download - Or you provide your own genomes/annotations 2. Describes genome assembly: 1. BUSCO: Evaluates genome completeness based on single copy markers. 2. BUSCO Ideogram: Plots the location of markers on the assembly. 3. Merqury (optional): Evaluates genome completeness based on sequencing reads. 4. tidk (optional): Indetifies and visualises telomeric repeats. 5. QUAST: Computes contiguity and integrity statistics: N50, N90, GC%, number of sequences. 6. More options... 3. Describes annotation : 1. AGAT: Number of genes, features, length... 2. Gene Overlaps: Finds the number of overlapping genes. 3. More options... 5. Extracts longest protein isoform: GffRead. 6. Finds orthologous genes: Orthofinder. 7. Plots an orthology-based phylogenetic tree : Tee Summary, as well as other relevant stats from the above steps. 8. Summary with MultiQC.

[!WARNING] We strongly suggest users to specify the lineage using the --busco_lineage parameter, as setting the lineage to auto (default value) might cause problems with BUSCO during the lineage determination step.

[!NOTE] BUSCO Ideogram will only plot those chromosomes -or scaffolds- that contain at least one single copy marker.

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.

First, prepare an input samplesheet in csv format (e.g. samplesheet.csv). You can prepare your sampplesheet using:

1. Local files

Simply point out to your local genome assembly and annotation (in FASTA and GFF format, respectively) using the fasta and gff fields:

csv species,refseq,fasta,gff,fastq species_1,,/path/to/genome.fasta,/path/to/annotation.gff3, species_2,,/path/to/genome.fasta,/path/to/annotation.gff3, species_3,,/path/to/genome.fasta,/path/to/annotation.gff3,

2. ncbi accessions

Additionally, you can run the pipeline using providing ncbi accessions (RefSeq or GenBank, depeding on the mode you wish to run) in the ncbi field:

csv species,refseq,fasta,gff,fastq species_1,GCF_000000001.1,,, species_2,GCF_000000002.1,,, species_3,GCF_000000003.1,,,

Run the pipeline

Run the pipeline using:

bash nextflow run nf-core/genomeqc \ -profile <docker/singularity/.../institute> \ --input samplesheet.csv \ --outdir <OUTDIR>

You can run the pipeline using a test profile and docker:

bash nextflow run nf-core/genomeqc -profile test,docker --outdir ./results

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

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.

Credits

nf-core/genomeqc was originally written by Chris Wyatt and Fernando Duarte at the University College London.

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

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.

python app/downloader-utility.py --clade "Chordata" --projectname "DToL" --datastatus "Mapped Reads - Done" --experimenttype "Chromium genome" --downloadlocation "/Users/raheela/Documents" --downloadoption "assemblies" --specieslist "Apamea sordens,Bufo bufo"

Owner

  • Name: nf-core
  • Login: nf-core
  • Kind: organization
  • Email: core@nf-co.re

A community effort to collect a curated set of analysis pipelines built using Nextflow.

Citation (CITATIONS.md)

# ecoflow/genomeqc: 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/)

  > Andrews, S. (2010). FastQC: A Quality Control Tool for High Throughput Sequence Data [Online].

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

- [RIdeogram](https://cran.r-project.org/web/packages/RIdeogram/vignettes/RIdeogram.html)

  > Hao, Z., Lv, D., Ge, Y. et al. RIdeogram: drawing SVG graphics to visualize and map genome-wide data on the idiograms. PeerJ Comput. Sci. 6, e251 (2020). https://doi.org/10.7717/peerj-cs.251

## 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)

  > Merkel, D. (2014). Docker: lightweight linux containers for consistent development and deployment. Linux Journal, 2014(239), 2. 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: 85
  • Watch event: 15
  • Delete event: 10
  • Issue comment event: 131
  • Push event: 83
  • Pull request review event: 49
  • Pull request review comment event: 82
  • Pull request event: 67
  • Fork event: 11
  • Create event: 19
Last Year
  • Issues event: 85
  • Watch event: 15
  • Delete event: 10
  • Issue comment event: 131
  • Push event: 83
  • Pull request review event: 49
  • Pull request review comment event: 82
  • Pull request event: 67
  • Fork event: 11
  • Create event: 19

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 47
  • Total pull requests: 39
  • Average time to close issues: 13 days
  • Average time to close pull requests: 10 days
  • Total issue authors: 6
  • Total pull request authors: 11
  • Average comments per issue: 0.28
  • Average comments per pull request: 1.0
  • Merged pull requests: 18
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 47
  • Pull requests: 39
  • Average time to close issues: 13 days
  • Average time to close pull requests: 10 days
  • Issue authors: 6
  • Pull request authors: 11
  • Average comments per issue: 0.28
  • Average comments per pull request: 1.0
  • Merged pull requests: 18
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • FernandoDuarteF (20)
  • chriswyatt1 (17)
  • stephenturner (7)
  • hbadrane (1)
  • tanashreebioinfo (1)
  • Juke34 (1)
Pull Request Authors
  • FernandoDuarteF (14)
  • chriswyatt1 (11)
  • nf-core-bot (6)
  • Juke34 (1)
  • BenjaminATaylor (1)
  • SimonDMurray (1)
  • fperezcobos (1)
  • GallVp (1)
  • awanalkoerdi289 (1)
  • LaurenHuet (1)
  • stephenturner (1)
Top Labels
Issue Labels
enhancement (7) bug (5)
Pull Request Labels
enhancement (1)

Dependencies

modules/nf-core/busco/busco/meta.yml cpan
modules/nf-core/fastqc/meta.yml cpan
modules/nf-core/gffread/meta.yml cpan
modules/nf-core/multiqc/meta.yml cpan
modules/nf-core/ncbigenomedownload/meta.yml cpan
modules/nf-core/orthofinder/meta.yml cpan
modules/nf-core/pigz/uncompress/meta.yml cpan
subworkflows/nf-core/utils_nextflow_pipeline/meta.yml cpan
subworkflows/nf-core/utils_nfcore_pipeline/meta.yml cpan
subworkflows/nf-core/utils_nfvalidation_plugin/meta.yml cpan
modules/nf-core/seqkit/seq/meta.yml cpan
modules/nf-core/seqkit/sort/meta.yml cpan
modules/nf-core/tidk/explore/meta.yml cpan
modules/nf-core/tidk/plot/meta.yml cpan
modules/nf-core/tidk/search/meta.yml cpan
subworkflows/nf-core/fasta_explore_search_plot_tidk/meta.yml cpan
modules/nf-core/agat/spstatistics/meta.yml cpan
modules/nf-core/quast/meta.yml cpan
modules/nf-core/agat/spstatistics/environment.yml conda
  • agat 1.4.0.*
modules/nf-core/busco/busco/environment.yml conda
  • busco 5.7.1.*
modules/nf-core/fastqc/environment.yml conda
  • fastqc 0.12.1.*
modules/nf-core/gffread/environment.yml conda
  • gffread 0.12.7.*
modules/nf-core/multiqc/environment.yml conda
  • multiqc 1.21.*
modules/nf-core/ncbigenomedownload/environment.yml conda
  • ncbi-genome-download 0.3.3.*
modules/nf-core/orthofinder/environment.yml conda
  • diamond 2.1.9.*
  • orthofinder 2.5.5.*
modules/nf-core/quast/environment.yml conda
  • quast 5.2.0.*
modules/nf-core/seqkit/seq/environment.yml pypi
modules/nf-core/seqkit/sort/environment.yml pypi
modules/nf-core/tidk/explore/environment.yml pypi
modules/nf-core/tidk/plot/environment.yml pypi
modules/nf-core/tidk/search/environment.yml pypi