funphehr

A fungal assembly and annotation nextflow pipeline

https://github.com/sap-phe-bioinformatics/funphehr

Science Score: 54.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
  • DOI references
    Found 27 DOI reference(s) in README
  • Academic publication links
    Links to: ncbi.nlm.nih.gov
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A fungal assembly and annotation nextflow pipeline

Basic Info
  • Host: GitHub
  • Owner: SAP-PHE-Bioinformatics
  • License: mit
  • Language: Nextflow
  • Default Branch: master
  • Size: 2.37 MB
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created about 2 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

nf-funPHEhr funPHEhr

Introduction

nf-funphehr (pronounced fun-fair) is a bioinformatics pipeline that can be used to analyse Nanopore sequencing data obtained from fungal isolates. It takes a samplesheet and fastq files as input, performs QC, trimming, assembly, assembly QC and annotation(in dev). This is the public version of the pipeline being developed at SA Pathology. Please note annotation processes still in development.

nf-funphehr metro map 1. Trim adapters (FastQC) 2. Trim low quality and short reads (chopper) 3. Present QC of reads post trimming (Nanoplot) 4. Screen reads for contamination (kraken2) 5. Denovo Assembly - flye (flye) OR - miniasm -> minimap2 -> racon (miniasm) (minimap2) (racon)

  1. Polishing reads (optional) (medaka)
  2. Extract of ITS1-5.8S-ITS2 region (ITSx)
  3. Assembly assessment report (QUAST)
  4. Assembly quality (BUSCO)
  5. Structural annotation using deep neural network (Helixer)
  6. Functional annotation using interproscan(Interproscan)
  7. Functional annotation using blastP
  8. Merge annotations into single gff (*agat_sp_manage_functional_annotation.pl) *(custom script in development still to replace this perl script)
  9. Present metrics from run (MultiQC)

Usage

First, prepare a samplesheet with your input data that looks as follows:

samplesheet.csv:

csv ID,LongFastq,GenomeSize, species 231862455,./data/S1_long_fastq.gz,14.0m,"Candida albicans" 231495562,./data/S1_long_fastq.gz,26.0m,"Candida parapsilosis" NEG, ./data/NEG_1.fastq.gz,,

Each row represents a fastq file (single-end) of long reads. Any line with ID NEG will not have stop before assembly. kraken2 used to screen contamination of the run negative control.

Now, you can run the pipeline using:

bash nextflow run https://github.com/SAP-PHE-Bioinformatics/FunPHEhr/ \ -profile <docker/apptainer/singularity/...> \ --input samplesheet.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. :::

** Please not nextflow.config file may need to be have paths updated for databases for kraken2, busco and for annotation steps.

Citations

This pipeline was built using nextflow and following nf-core template.

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.

Acknowledgement to all the authors of tools used within the pipeline.

Pipeline name

Context for the name of this pipeline, the name funPHEhr orginates from Lex Leong, Genomic Lead of the SA Pathology Public Health and Epidemiology Lab. He has a challenge to get the abbrevation of our Lab (PHE) into all the names of our pipelines. This pipeline was not immune and has been given the name funPHEhr where the logo for this pipeline is a fair/fete tent as seen below in image of the SA Path PHE pipelines. You can try and work our the other pipeline names using the logos.

phe_pipelines

Owner

  • Name: SA Pathology Public Health and Pathogen Genomics
  • Login: SAP-PHE-Bioinformatics
  • Kind: organization
  • Location: Australia

The public health laboratory of notifiable diseases for South Australia, Australia

Citation (CITATIONS.md)

# nf-core/funphehr: 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.

## 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: 1
  • Watch event: 1
  • Push event: 1
Last Year
  • Issues event: 1
  • Watch event: 1
  • Push event: 1