assembly_amr
This is a Nextflow pipeline for analyzing whole-genome sequencing data from bacterial isolates.
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 (13.1%) to scientific vocabulary
Repository
This is a Nextflow pipeline for analyzing whole-genome sequencing data from bacterial isolates.
Basic Info
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
- Releases: 0
Metadata Files
README.md
Assembly & AMR
The pipeline is currently under development!
Author
- Andreas Evenstad (https://github.com/aevenstad/)
Table of contents
Introduction
This is a Nextflow pipeline written using the nf-core template, and is made for analyzing whole-genome sequencing data from bacterial isolates.
Its main function is to asses antimicrobial resistance in the provided isolates and the main steps of the pipeline is:
* Genome assembly:
-hybridorlong` mode with hybracter (0.11.0)
- Short read mode with shovill (1.1.0) (using spades assembler)
* Multi locus sequence typing:
- MLST (2.23.0)
- rMLST (https://gist.github.com/kjolley/703fa2f00c3b2abeef9242fa193ea901#file-speciesapiupload-py)
* Resistance analysis:
- AMRFinderPlus (4.0.3)
- Kleborate (3.1.2) (for Klebsiella)
- PlasmidFinder (2.1.6)
- LRE-Finder (1.0.0) (for enterobactales)
* Annotation:
- Bakta (1.10.4)
Requirements
Dependencies
This pipeline is developed with singularity for tool dependencies. Most of the containers used is accessible from public registries like quay and biocontainers
but for the tools not available in the registries local builds are currently used.
Databases
In order for the pipeline to run these databases must be available on the system: * AMRFinderPlus database (release 2024-10-22.1 or later) * PlasmidFinder database * Bakta database (optionally for annotation)
Quickstart
Download the pipeline
Clone the repository:
git clone https://github.com/aevenstad/assembly_amr.git
Get dependencies
You can optionally install dependencies before running the pipeline using the helper scripts in bin/.
It’s recommended to set the container directory using the Nextflow variable $NXF_SINGULARITY_CACHEDIR:
```
NXFSINGULARITYCACHEDIR=/path/to/containers/
to pull containers from public registries, run:
bash bin/pullcontainers.sh $NXFSINGULARITY_CACHEDIR
for dependencies without publicly available container images, use:
bash bin/buildcontainers.sh $NXFSINGULARITY_CACHEDIR
``
This will build the required containers using custom definition files insingularity/`.
Download databases
AMRFinderPlus database:
singularity exec <amrfinderplus_image> amrfinder_update -d <database_dir>
PlasmidFinder database: ```
go to preferred database directory
cd
clone the latest version of the database:
git clone https://bitbucket.org/genomicepidemiology/plasmidfinderdb.git cd plasmidfinderdb PLASMID_DB=$(pwd)
install the database:
singularity exec
Bakta database:
cd <database_dir>
singularity exec <bakta_image> bakta_db download --output ./ --type [light|full]
Arguments
-profile [string] Name of profile from `nextflow.conf` (Currently only <singularity> supported)
--input [string] Path to input samplesheet
--outdir [string] Path to output directory
--assembly_type [string] Type of assembly to perform (accepted: hybrid, long, short)
--amrfinder_db [string] Path to the AMRFinderPlus database
--plasmidfinder_db [string] Path to the PlasmidFinder database
--bakta [boolean] Run annotation with bakta [default: false]
--bakta_db [string] Path to the bakta database
Run the pipeline
nextflow run /path/to/assembly_amr/main.nf \
-profile singularity \
--input samplesheet.csv \
--outdir <outdir> \
--assembly_type [hybrid|long|short] \
--amrfinder_db <amrfinder_db> \
--plasmidfinder_db <plasmidfinder_db>
Hybrid input
If you have both Nanopore and Illumina reads from the same isolate and want to run a hybrid assembly, input must be provided in a comma-separated file e.g. samplesheet.csv:
sample,nanopore,illumina_R1,illumina_R2
isolate1,/path/to/nanopore/data/isolate1.fastq.gz,/path/to/illumina/data/isolate1_R1.fastq.gz,/path/to/illumina/data/isolate1_R2.fastq.gz
isolate2,/path/to/nanopore/data/isolate2.fastq.gz,/path/to/illumina/data/isolate2_R1.fastq.gz,/path/to/illumina/data/isolate2_R2.fastq.gz
Long-read input
For long read only assembly with Nanopore reads:
samplesheet.csv:
sample,nanopore
isolate1,/path/to/nanopore/data/isolate1.fastq.gz
isolate2,/path/to/nanopore/data/isolate2.fastq.gz
Short-read input
For short read only assembly with Illumina reads:
samplesheet.csv:
sample,illumina_R1,illumina_R2
isolate1,/path/to/illumina/data/isolate1_R1.fastq.gz,/path/to/illumina/data/isolate1_R2.fastq.gz
isolate2,/path/to/illumina/data/isolate2_R1.fastq.gz,/path/to/illumina/data/isolate2_R2.fastq.gz
Owner
- Name: Andreas Evenstad
- Login: aevenstad
- Kind: user
- Location: Norway
- Company: University of Tromsø
- Repositories: 2
- Profile: https://github.com/aevenstad
Citation (CITATIONS.md)
# kres/annotate_genomes: 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 - [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: 3
- Delete event: 6
- Issue comment event: 3
- Public event: 1
- Push event: 49
- Pull request event: 8
- Create event: 2
Last Year
- Issues event: 3
- Delete event: 6
- Issue comment event: 3
- Public event: 1
- Push event: 49
- Pull request event: 8
- Create event: 2
Dependencies
- ncbi-amrfinderplus 3.12.8.*
- bakta 1.10.4.*
- bbmap 39.01.*
- pigz 2.6.*
- samtools 1.16.1.*
- fastp 0.23.4.*
- fastqc 0.12.1.*
- kleborate 2.1.0.*
- mlst 2.23.0.*
- multiqc 1.25.1.*
- plasmidfinder 2.1.6
- quast 5.2.0.*
- shovill 1.1.0.*
- mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
- actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 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 0b93645e9fea7318ecaed2b359559ac225c90a2b composite
- eWaterCycle/setup-apptainer 4bb22c52d4f63406c49e94c804632975787312b3 composite
- jlumbroso/free-disk-space 54081f138730dfa15788a46383842cd2f914a1be composite
- nf-core/setup-nextflow v2 composite
- actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
- actions/setup-python 0b93645e9fea7318ecaed2b359559ac225c90a2b composite
- peter-evans/create-or-update-comment 71345be0265236311c031f5c7866368bd1eff043 composite
- actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
- actions/setup-python 0b93645e9fea7318ecaed2b359559ac225c90a2b composite
- actions/upload-artifact b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 composite
- nf-core/setup-nextflow v2 composite
- pietrobolcato/action-read-yaml 1.1.0 composite
- dawidd6/action-download-artifact 80620a5d27ce0ae443b965134db88467fc607b43 composite
- marocchino/sticky-pull-request-comment 331f8f5b4215f0445d3c07b4967662a32a2d3e31 composite
- actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
- mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
- nichmor/minimal-read-yaml v0.0.2 composite