nanotax
a pipeline for the characterization of microbial communities with Nanopore
Science Score: 67.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
Links to: ncbi.nlm.nih.gov -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.4%) to scientific vocabulary
Repository
a pipeline for the characterization of microbial communities with Nanopore
Basic Info
- Host: GitHub
- Owner: JacquelineAldridge
- License: mit
- Language: Nextflow
- Default Branch: main
- Size: 157 KB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 1
- Releases: 1
Metadata Files
README.md
catg-umag/nanotax
Introduction
catg-umag/nanotax is a bioinformatics pipeline for the analysis of 16S rRNA gene sequencing data obtained by Nanopore sequencing. It takes a samplesheet with POD5 or FastQ files and barcodes (optional) and groups (optional) as input and performs basecalling and demultiplexing, quality control (QC), taxonomic assignment with databases, functional prediction and alpha diversity metrics and produces tables and plots with all the results. All the process are optional except taxonomic assignment.
The pipeline then:
1. Basecalling and demultiplexing with (Dorado).
2. Read QC (FastQC) and (NanoQ).
3. Quality and length filter with (NanoQ).
4. Sampling by quality with (Filtlong)
5. Present QC for raw reads (MultiQC)
6. Assigns taxonomy to reads using (MMSeqs2) with (Genbank) or (SILVA) database.
7. (optionally) alpha diversity metrics with (Vegan) (R).
8. (optionally) functional prediction with (PICRUSt2) .
9. (optionally) differential expression for functional prediction with(LEfSe).
All plots and tables are generated using Python, through either (pandas) or (polars).
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 testbefore running the workflow on actual data.
The columns in the sample file will vary depending on the analyses to be performed. Each row represents a sample, specifying either its associated FASTQ file or the barcode used during sequencing.
By default, the pipeline performs quality control and taxonomic assignment. For these tasks, the sample file must include the columns "samples" and "fastq".
csv
sample,fastq
sample_1,sample_1.fastq.gz
sample_2,sample_2.fastq.gz
If you wish to start from the basecalling step, the fastq column should be replaced with barcode , and the directory containing the POD5 files must be specified using the --basecalling.pod5_dir parameter.
csv
sample,barcode
sample_1,barcode01
sample_2,barcode02
To perform diversity analyses or differential expression of metabolic pathways, the sample file must include a groups column.
csv
sample,fastq,group
sample_1,sample_1.fastq.gz,G1
sample_2,sample_2.fastq.gz,G2
Now, you can run the pipeline using:
bash
nextflow run catg-umag/nanotax \
-profile <docker/apptainer/.../institute> \
--input samplesheet.csv \
--outdir <OUTDIR>
[!WARNING] Please provide pipeline parameters via the CLI or Nextflow
-params-fileoption. Custom config files including those provided by the-cNextflow option can be used to provide any configuration except for parameters; see docs.
Parameters
General parameters
The following parameters can be modified to enable or disable specific modules:
| Parameter | Type | Description | Default |
|----------------------|---------|-------------|---------|
| basecalling.run | boolean | Enable run basecalling and demultiplexing | false
| qc.run | boolean | Enable run quality check | true
| diversity.run | boolean | Enable run diversity analysis module | true if samplesheet has groups
| functional_pred.run | boolean | Enable run functional prediction | true if samplesheet has groups
| exclude | list | samples that are not included in the analyses, but their quality and quantity of readings information will be reported | []
Each module has specific parameters that can be configured when enabled.
Basecalling module
| Parameter | Type | Description | Default |
|----------------------|---------|-------------|---------|
| basecalling.pod5dir | string | directory containing POD5 files | input/pod5
| basecalling.gpus | integer | Number of GPUs to use | 1
| basecalling.doradobasecallingmodel | string | Basecalling model to use (fast, hac, sup) | sup
| basecalling.qscorefilter | integer | Q-score threshold for passing and failing reads | 10
| basecalling.barcodingkit | string | Barcoding kit used for multiplexing | SQK-16S114-24
| basecalling.savereads | boolean | Save reads after basecalling and demultiplexing in the results directory | false
QC module
| Parameter | Type | Description | Default |
|----------------------|---------|-------------|---------|
| qc.subsampling | integer | Number of reads to sampling | 100000
| qc.minlength | integer | Minimum required length for a read |1000
| qc.maxlength | integer | Maximum allowed length for a read | 2000
| qc.minqscore | integer | Minimum q-score | 15
| qc.savereads | boolean | Save reads after quality control in the results directory | false
Taxonomic assignment module
| Parameter | Type | Description | Default |
|----------------------|---------|-------------|---------|
| taxonomicassignment.minaln | integer | Minimum alignment length to retain an alignment | 1000
| taxonomicassignment.minidentity | integer | Minimum sequence identity between the read and database hit (range: 0–1) | 0.95
| taxonomicassignment.downloaddb | boolean | Download the database from the internet | true
| taxonomicassignment.dbname | string | Database name to use (genbank or silva) | genbank
| taxonomicassignment.dbdir | string | Directory containing the database (required if download_db is false) | `` (empty)
The diversity and functional prediction modules do not have specific parameters associated with them.
Credits
catg-umag/nanotax was originally written by JacquelineAldridge.
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
- Login: JacquelineAldridge
- Kind: user
- Repositories: 1
- Profile: https://github.com/JacquelineAldridge
Citation (CITATIONS.md)
# catg-umag/nanotax: 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 - [`NanoQ`](https://github.com/esteinig/nanoq) > Nanoq: ultra-fast quality control for nanopore reads <!-- - [`Filtlong`](https://github.com/rrwick/Filtlong) > --> - [`MMSeqs2`](https://github.com/soedinglab/MMseqs2) > MMseqs2 enables sensitive protein sequence searching for the analysis of massive data sets - [`Vegan`](https://cran.r-project.org/web/packages/vegan/vegan.pdf) > VEGAN, a package of R functions for community ecology - [`PICRUSt2`](https://github.com/picrust/picrust2) > PICRUSt2 for prediction of metagenome functions <!-- -[`LEfSe`](https://huttenhower.sph.harvard.edu/lefse/) > --> - [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: 1
- Watch event: 1
- Member event: 1
- Public event: 1
- Push event: 13
- Pull request event: 13
- Fork event: 2
- Create event: 3
Last Year
- Release event: 1
- Watch event: 1
- Member event: 1
- Public event: 1
- Push event: 13
- Pull request event: 13
- Fork event: 2
- Create event: 3
Dependencies
- mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
- actions/checkout 0ad4b8fadaa221de15dcec353f45205ec38ea70b composite
- conda-incubator/setup-miniconda a4260408e20b96e80095f42ff7f1a15b27dd94ca composite
- eWaterCycle/setup-apptainer main composite
- jlumbroso/free-disk-space 54081f138730dfa15788a46383842cd2f914a1be composite
- nf-core/setup-nextflow v2 composite
- actions/stale 28ca1036281a5e5922ead5184a1bbf96e5fc984e composite
- actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
- eWaterCycle/setup-apptainer 4bb22c52d4f63406c49e94c804632975787312b3 composite
- jlumbroso/free-disk-space 54081f138730dfa15788a46383842cd2f914a1be composite
- nf-core/setup-nextflow v2 composite
- actions/checkout 0ad4b8fadaa221de15dcec353f45205ec38ea70b composite
- actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
- peter-evans/create-or-update-comment 71345be0265236311c031f5c7866368bd1eff043 composite
- actions/checkout 0ad4b8fadaa221de15dcec353f45205ec38ea70b composite
- actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
- actions/upload-artifact 65462800fd760344b1a7b4382951275a0abb4808 composite
- nf-core/setup-nextflow v2 composite
- pietrobolcato/action-read-yaml 1.1.0 composite
- dawidd6/action-download-artifact bf251b5aa9c2f7eeb574a96ee720e24f801b7c11 composite
- marocchino/sticky-pull-request-comment 331f8f5b4215f0445d3c07b4967662a32a2d3e31 composite
- actions/checkout 0ad4b8fadaa221de15dcec353f45205ec38ea70b composite
- mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
- nichmor/minimal-read-yaml v0.0.2 composite