nf-core-fluseq
Science Score: 44.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
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.4%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: RasmusKoRiis
- License: mit
- Language: Nextflow
- Default Branch: master
- Size: 637 MB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
- Releases: 4
Metadata Files
README.md
nf-core/fluseq :sneezing_face:
Introduction
This pipeline processes FASTQ files from Nanopore sequencing of Influenza A and B, generating consensus sequences and analyzing them for mutations, sequencing statistics, and drug resistance effects. The main steps include:
- Alignment and consensus sequencing with IRMA.
- Consensus sequence analysis with Nextclade.
- Mutation calling for all segments.
- Generation of a comprehensive report in CSV format.
- Output of sequences in a multiple FASTA file.
The pipeline consist of four different worflows listed bellow:
1) Human Influenza FASTQ analysis (human) Alignment of FASTQ and mutation analysis 2) Human Influenza FASTA analysis (human-fasta) (under development) Mutation analysis 3) Avian Influenza FASTQ analysis (avian) Alignment of FASTQ and mutation analysis 4) Avian Influenza FASTA analysis (avian-fasta) Mutation analysis
Compatibility
- Operating System: Linux
- Dependencies: Docker and Nextflow
Usage
Sample Sheet Preparation
Prepare a sample sheet (CSV or TSV*) in the assets folder with the following format:
* TSV file is not not compulsory
PCR-PlatePosition,SequenceID,Barcode,KonsCt
A1*,sampleID,barcodeID,ct-value*
*not compulsory
Each row lists a sample to be analyzed. Samples not listed in the sheet will be excluded from the analysis.
Directory Structure
For FASTQ-analysis
Ensure your directory structure is as follows:
./
|-data
|-barcode3
|-XXXX_pass_barcode03_XXXX.fastq.gz
|-YYYY_pass_barcode03_YYYY.fastq.gz
|-nf-core-fluseq
|-assets
|-samplesheet.csv
|-samplesheet.tsv
|-...
Running the Pipeline
Navigate to the nf-core-fluseq folder and execute the following command with default parameters:
Human Influenza FASTQ analysis
bash
nextflow run main.nf -profile docker --runid runid_name --outdir ../outdir_name
Avian Influenza FASTQ analysis
bash
nextflow run main.nf -profile docker --file avian-fastq --genotype_database database* --runid runid_name --outdir ../outdir_name
* The database given as the genotyping database must be in the format given bellow:
```
DatabaseNumber|Subtype|ID|Segment|SegmentNumber|GISAIDID aa.. DatabaseNumber|Subtype|ID|Segment|SegmentNumber|GISAIDID a.. ```
Example of header: ```
21|H5N8|chicken/norway|HA|4|EPIESL_7473825 ```
The database number is used in the genotyping02.py script to identify genotypes. Either the offical database has to be obtained or this script has to be adjusted to a be compatible to a in-house genotyping database.
Avian Influenza FASTA analysis
bash
nextflow run main.nf -profile docker --file avian-fasta --genotype_database database --runid runid_name --outdir ../outdir_name
Important Parameters
--input(default:assets/samplesheet.csv): Path to the samplesheet.--seq_quality_threshold(default: 20): Coverage threshold for analysis of consensus sequences.--samplesDir(default:../data): Directory containing the FASTQ files in the structure given above.
All parameters are detailed in the nextflow.config file.
Pipeline Output
The output includes:
- Consensus sequences.
- Mutation calls.
- Sequencing statistics (coverage, quality parameters).
- Drug resistance effects.
- A report in CSV format.
- A multiple FASTA file of sequences that passed quality filters.
Credits
fluseq was originally written by Rasmus Kopperud Riis.
Owner
- Login: RasmusKoRiis
- Kind: user
- Repositories: 1
- Profile: https://github.com/RasmusKoRiis
Citation (CITATIONS.md)
# nf-core/fluseq: 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
- Release event: 5
- Watch event: 1
- Push event: 105
- Create event: 4
Last Year
- Release event: 5
- Watch event: 1
- Push event: 105
- Create event: 4
Dependencies
- actions/upload-artifact v3 composite
- seqeralabs/action-tower-launch v2 composite
- actions/upload-artifact v3 composite
- seqeralabs/action-tower-launch v2 composite
- mshick/add-pr-comment v1 composite
- actions/checkout v3 composite
- nf-core/setup-nextflow v1 composite
- actions/stale v7 composite
- actions/checkout v3 composite
- actions/setup-node v3 composite
- actions/checkout v3 composite
- actions/setup-node v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- mshick/add-pr-comment v1 composite
- nf-core/setup-nextflow v1 composite
- psf/black stable composite
- dawidd6/action-download-artifact v2 composite
- marocchino/sticky-pull-request-comment v2 composite
- actions/setup-python v4 composite
- rzr/fediverse-action master composite
- zentered/bluesky-post-action v0.0.2 composite