bactopia

A flexible pipeline for complete analysis of bacterial genomes

https://github.com/bactopia/bactopia

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 15 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    2 of 13 committers (15.4%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.9%) to scientific vocabulary

Keywords

bacterial-genomes bioconda conda fastqs nextflow
Last synced: 6 months ago · JSON representation ·

Repository

A flexible pipeline for complete analysis of bacterial genomes

Basic Info
  • Host: GitHub
  • Owner: bactopia
  • License: mit
  • Language: Nextflow
  • Default Branch: master
  • Homepage: https://bactopia.github.io
  • Size: 48.8 MB
Statistics
  • Stars: 469
  • Watchers: 17
  • Forks: 78
  • Open Issues: 89
  • Releases: 51
Topics
bacterial-genomes bioconda conda fastqs nextflow
Created almost 7 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

GitHub release (latest by date) mSystems Anaconda-Server Badge Gitpod ready-to-code

Bactopia Logo

Bactopia

Bactopia is a flexible pipeline for complete analysis of bacterial genomes. The goal of Bactopia is to process your data with a broad set of tools, so that you can get to the fun part of analyses quicker!

Bactopia can be split into two main parts: Bactopia Analysis Pipeline, and Bactopia Tools.

Bactopia Analysis Pipeline is the main per-isolate workflow in Bactopia. Built with Nextflow, input FASTQs (local or available from SRA/ENA) are put through numerous analyses including: quality control, assembly, annotation, minmer sketch queries, sequence typing, and more.

Bactopia Overview

Bactopia Tools are a set a independent workflows for comparative analyses. The comparative analyses may include summary reports, pan-genome, or phylogenetic tree construction. Using the predictable output structure of Bactopia you can pick and choose which samples to include for processing with a Bactopia Tool.

Bactopia was inspired by Staphopia, a workflow we (Tim Read and myself) released that targets Staphylococcus aureus genomes. Using what we learned from Staphopia and user feedback, Bactopia was developed from scratch with usability, portability, and speed in mind from the start.

Documentation

Documentation for Bactopia is available at https://bactopia.github.io/. The documentation includes a tutorial replicating Staphopia and a complete overview of Bactopia. I highly encourage you check it out!

Quick Start

``` mamba create -y -n bactopia -c conda-forge -c bioconda bactopia conda activate bactopia bactopia datasets

Paired-end

bactopia --R1 R1.fastq.gz --R2 R2.fastq.gz --sample SAMPLE_NAME \ --datasets datasets/ --outdir OUTDIR

Single-End

bactopia --SE SAMPLE.fastq.gz --sample SAMPLE --datasets datasets/ --outdir OUTDIR

Multiple Samples

bactopia prepare MY-FASTQS/ > fastqs.txt bactopia --fastqs fastqs.txt --datasets datasets --outdir OUTDIR

Single ENA/SRA Experiment

bactopia --accession SRX000000 --datasets datasets --outdir OUTDIR

Multiple ENA/SRA Experiments

bactopia search "staphylococcus aureus" > accessions.txt bactopia --accessions accessions.txt --dataset datasets --outdir ${OUTDIR} ```

Installation

Bactopia has a lot of tools built into its workflow. As you can imagine, all these tools lead to numerous dependencies, and navigating dependencies can often turn into a very frustrating process. With this in mind, from the onset Bactopia was developed to only include programs that are installable using Conda.

Conda is an open source package management system and environment management system that runs on Windows, macOS and Linux. In other words, it makes it super easy to get the tools you need installed! The official Conda documentation is a good starting point for getting started with Conda. Bactopia has been tested using the Miniforge installer, but the Anaconda installer should work the same.

Once you have Conda all set up, you are ready to create an environment for Bactopia.

```

Recommended

mamba create -n bactopia -c conda-forge -c bioconda bactopia

or with standard conda

conda create -n bactopia -c conda-forge -c bioconda bactopia ```

After a few minutes you will have a new conda environment suitably named bactopia. To activate this environment, you will can use the following command:

conda activate bactopia

And voilà, you are all set to get started processing your data!

Please Cite Datasets and Tools

If you have used Bactopia in your work, please be sure to cite any datasets or tools you may have used. A list of each dataset/tool used by Bactopia has been made available.

If a citation needs to be updated please let me know!

Acknowledgements

Bactopia is truly a case of "standing upon the shoulders of giants". Nearly every component of Bactopia was created by others and made freely available to the public.

I would like to personally extend my many thanks and gratitude to the authors of these software packages and public datasets. If you've made it this far, I owe you a beer 🍻 (or coffee ☕!) if we ever encounter one another in person. Really, thank you very much!

Alternatives

In case Bactopia doesn't fit your needs, here are some alternatives you can checkout. I personally haven't used them, but you might find them to fit your needs! If you ran into issues using Bactopia, please feel free to reach out!

  • AQUAMIS
    Deneke C, Brendebach H, Uelze L, Borowiak M, Malorny B, Tausch SH. Species-Specific Quality Control, Assembly and Contamination Detection in Microbial Isolate Sequences with AQUAMIS. Genes. 2021;12. doi:10.3390/genes12050644

  • ASA³P
    Schwengers O, Hoek A, Fritzenwanker M, Falgenhauer L, Hain T, Chakraborty T, Goesmann A. ASA³P: An automatic and scalable pipeline for the assembly, annotation and higher-level analysis of closely related bacterial isolates. PLoS Comput Biol 2020;16:e1007134. https://doi.org/10.1371/journal.pcbi.1007134.

  • MicroPIPE
    Murigneux V, Roberts LW, Forde BM, Phan M-D, Nhu NTK, Irwin AD, Harris PNA, Paterson DL, Schembri MA, Whiley DM, Beatson SA MicroPIPE: validating an end-to-end workflow for high-quality complete bacterial genome construction. BMC Genomics, 22(1), 474. (2021) https://doi.org/10.1186/s12864-021-07767-z

  • Nullarbor
    Seemann T, Goncalves da Silva A, Bulach DM, Schultz MB, Kwong JC, Howden BP. Nullarbor Github https://github.com/tseemann/nullarbor

  • ProkEvo
    Pavlovikj N, Gomes-Neto JC, Deogun JS, Benson AK ProkEvo: an automated, reproducible, and scalable framework for high-throughput bacterial population genomics analyses. PeerJ, e11376 (2021) https://doi.org/10.7717/peerj.11376

  • Public Health Bacterial Genomics
    Libuit K, Ambrosio F, Kapsak C Public Health Bacterial Genomics GitHub https://github.com/theiagen/publichealthbacterial_genomics

  • rMAP
    Sserwadda I, Mboowa G rMAP: the Rapid Microbial Analysis Pipeline for ESKAPE bacterial group whole-genome sequence data. Microbial Genomics, 7(6). (2021) https://doi.org/10.1099/mgen.0.000583

  • TORMES
    Quijada NM, Rodríguez-Lázaro D, Eiros JM, Hernández M. TORMES: an automated pipeline for whole bacterial genome analysis. Bioinformatics 2019;35:4207–12. https://doi.org/10.1093/bioinformatics/btz220.

Feedback

Your feedback is very valuable! If you run into any issues using Bactopia, have questions, or have some ideas to improve Bactopia, I highly encourage you to submit it to the Issue Tracker.

License

MIT License

Citation

Petit III RA, Read TD, Bactopia: a flexible pipeline for complete analysis of bacterial genomes. mSystems. 5 (2020), https://doi.org/10.1128/mSystems.00190-20.

Author

Funding

Support for this project came (in part) from an Emory Public Health Bioinformatics Fellowship funded by the CDC Emerging Infections Program (U50CK000485) PPHF/ACA: Enhancing Epidemiology and Laboratory Capacity, the Wyoming Public Health Division, and the Center for Applied Pathogen Epidemiology and Outbreak Control (CAPE).

Georgia Emerging Infections Program Wyoming Public Health Division Center for Applied Pathogen Epidemiology and Outbreak Control

Owner

  • Name: Bactopia
  • Login: bactopia
  • Kind: organization
  • Location: United States of America

Nextflow DSL2 pipeline for the complete analysis of bacterial genomes

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use Bactopia, please cite it as below."
authors:
- family-names: "Petit III"
  given-names: "Robert A. "
  orcid: "https://orcid.org/0000-0002-1350-9426"
- family-names: "Read"
  given-names: "Timothy D."
  orcid: "https://orcid.org/0000-0001-8966-9680"
title: "Bactopia: a Flexible Pipeline for Complete Analysis of Bacterial Genomes. mSystems. 5 (2020)"
doi: 10.1128/mSystems.00190-20
url: "https://github.com/bactopia/bactopia"
version: 1.4.1

GitHub Events

Total
  • Create event: 2
  • Release event: 2
  • Issues event: 81
  • Watch event: 51
  • Delete event: 1
  • Issue comment event: 184
  • Push event: 44
  • Pull request review comment event: 10
  • Pull request event: 10
  • Pull request review event: 5
  • Fork event: 9
Last Year
  • Create event: 2
  • Release event: 2
  • Issues event: 81
  • Watch event: 51
  • Delete event: 1
  • Issue comment event: 184
  • Push event: 44
  • Pull request review comment event: 10
  • Pull request event: 10
  • Pull request review event: 5
  • Fork event: 9

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 1,374
  • Total Committers: 13
  • Avg Commits per committer: 105.692
  • Development Distribution Score (DDS): 0.022
Past Year
  • Commits: 180
  • Committers: 3
  • Avg Commits per committer: 60.0
  • Development Distribution Score (DDS): 0.039
Top Committers
Name Email Commits
Robert A. Petit III r****t@g****m 1,344
Davi J. Marcon (@Mxrcon) d****n@g****m 9
rpetit3 r****3 5
Robert Petit r****t@f****u 4
Robert A. Petit III r****t@t****m 2
Nicholas Hathaway n****y@g****m 2
Idowu Olawoye i****e@g****m 2
Thomas Gotwig t****g@g****m 1
Jitao David Zhang d****u@g****m 1
Finlay Maguire f****e@g****m 1
Robert A Petit III r****t@s****u 1
Bruno P. Kinoshita k****w 1
Mxrcon 4****n 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 266
  • Total pull requests: 31
  • Average time to close issues: 6 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 144
  • Total pull request authors: 9
  • Average comments per issue: 4.65
  • Average comments per pull request: 1.26
  • Merged pull requests: 28
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 72
  • Pull requests: 16
  • Average time to close issues: 24 days
  • Average time to close pull requests: 9 days
  • Issue authors: 44
  • Pull request authors: 4
  • Average comments per issue: 1.31
  • Average comments per pull request: 1.75
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • rpetit3 (31)
  • llk578496 (9)
  • Svnipni (8)
  • andreaniml (7)
  • diaz13 (6)
  • incoherentian (6)
  • aperreault (6)
  • ingridvanw (5)
  • lfenske-93 (5)
  • alienzj (4)
  • nmmahmed (4)
  • rwilliams (4)
  • pvanheus (3)
  • iferres (3)
  • plasminogene (3)
Pull Request Authors
  • rpetit3 (14)
  • maxlcummins (7)
  • rwilliams (3)
  • idolawoye (2)
  • MartinVad (1)
  • mehalter (1)
  • coxrs (1)
  • pvanheus (1)
  • iferres (1)
Top Labels
Issue Labels
bug (108) question (86) fixed (45) enhancement (38) fixed-in-v3 (28) add-bactopia-tool (10) v4 (6) v2.0.0 (2) help wanted (2) done (1) low-priority (1) post-idea (1) urgent (1)
Pull Request Labels
enhancement (1) question (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 50
proxy.golang.org: github.com/bactopia/bactopia
  • Versions: 50
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

Dependencies

.github/workflows/all-bactopia-tests.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite
.github/workflows/all-bactopia-tool-tests.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite
.github/workflows/conda-build-manual.yml actions
  • actions/checkout v3 composite
  • conda-incubator/setup-miniconda v2 composite
.skeleton/subworkflows/meta.yml cpan
modules/local/bactopia/assembler/meta.yml cpan
modules/local/bactopia/gather/meta.yml cpan
modules/local/bactopia/qc/meta.yml cpan
modules/local/bactopia/sketcher/meta.yml cpan
modules/nf-core/abricate/run/meta.yml cpan
modules/nf-core/abricate/summary/meta.yml cpan
modules/nf-core/abritamr/run/meta.yml cpan
modules/nf-core/agrvate/meta.yml cpan
modules/nf-core/amrfinderplus/run/meta.yml cpan
modules/nf-core/amrfinderplus/update/meta.yml cpan
modules/nf-core/ariba/getref/meta.yml cpan
modules/nf-core/ariba/run/meta.yml cpan
modules/nf-core/bakta/download/meta.yml cpan
modules/nf-core/bakta/run/meta.yml cpan
modules/nf-core/blast/blastn/meta.yml cpan
modules/nf-core/blast/blastp/meta.yml cpan
modules/nf-core/blast/blastx/meta.yml cpan
modules/nf-core/blast/tblastn/meta.yml cpan
modules/nf-core/blast/tblastx/meta.yml cpan
modules/nf-core/bracken/meta.yml cpan
modules/nf-core/btyper3/meta.yml cpan
modules/nf-core/busco/meta.yml cpan
modules/nf-core/checkm/lineagewf/meta.yml cpan
modules/nf-core/clonalframeml/meta.yml cpan
modules/nf-core/csvtk/concat/meta.yml cpan
modules/nf-core/csvtk/join/meta.yml cpan
modules/nf-core/custom/dumpsoftwareversions/meta.yml cpan
modules/nf-core/ectyper/meta.yml cpan
modules/nf-core/eggnog/download/meta.yml cpan
modules/nf-core/eggnog/mapper/meta.yml cpan
modules/nf-core/emmtyper/meta.yml cpan
modules/nf-core/fastani/meta.yml cpan
modules/nf-core/gamma/meta.yml cpan
modules/nf-core/genotyphi/parse/meta.yml cpan
modules/nf-core/gtdbtk/classifywf/meta.yml cpan
modules/nf-core/gtdbtk/setupdb/meta.yml cpan
modules/nf-core/gubbins/meta.yml cpan
modules/nf-core/hicap/meta.yml cpan
modules/nf-core/hpsuissero/meta.yml cpan
modules/nf-core/iqtree/meta.yml cpan
modules/nf-core/ismapper/meta.yml cpan
modules/nf-core/kleborate/meta.yml cpan
modules/nf-core/kraken2/meta.yml cpan
modules/nf-core/legsta/meta.yml cpan
modules/nf-core/lissero/meta.yml cpan
modules/nf-core/mash/dist/meta.yml cpan
modules/nf-core/mashtree/meta.yml cpan
modules/nf-core/mcroni/meta.yml cpan
modules/nf-core/meningotype/meta.yml cpan
modules/nf-core/midas/species/meta.yml cpan
modules/nf-core/mlst/meta.yml cpan
modules/nf-core/mlst/update/meta.yml cpan
modules/nf-core/mobsuite/recon/meta.yml cpan
modules/nf-core/mykrobe/predict/meta.yml cpan
modules/nf-core/ncbigenomedownload/meta.yml cpan
modules/nf-core/ngmaster/meta.yml cpan
modules/nf-core/panaroo/run/meta.yml cpan
modules/nf-core/pasty/meta.yml cpan
modules/nf-core/pbptyper/meta.yml cpan
modules/nf-core/phispy/meta.yml cpan
modules/nf-core/phyloflash/makedb/meta.yml cpan
modules/nf-core/phyloflash/phyloflash/meta.yml cpan
modules/nf-core/pirate/meta.yml cpan
modules/nf-core/plasmidfinder/meta.yml cpan
modules/nf-core/pneumocat/meta.yml cpan
modules/nf-core/prokka/meta.yml cpan
modules/nf-core/quast/meta.yml cpan
modules/nf-core/rgi/heatmap/meta.yml cpan
modules/nf-core/rgi/main/meta.yml cpan
modules/nf-core/roary/meta.yml cpan
modules/nf-core/scoary/meta.yml cpan
modules/nf-core/seqsero2/meta.yml cpan
modules/nf-core/seroba/run/meta.yml cpan
modules/nf-core/shigatyper/meta.yml cpan
modules/nf-core/shigeifinder/meta.yml cpan
modules/nf-core/sistr/meta.yml cpan
modules/nf-core/snippy/core/meta.yml cpan
modules/nf-core/snippy/run/meta.yml cpan
modules/nf-core/snpdists/meta.yml cpan
modules/nf-core/spatyper/meta.yml cpan
modules/nf-core/srahumanscrubber/initdb/meta.yml cpan
modules/nf-core/srahumanscrubber/scrub/meta.yml cpan
modules/nf-core/ssuissero/meta.yml cpan
modules/nf-core/staphopiasccmec/meta.yml cpan
modules/nf-core/stecfinder/meta.yml cpan
modules/nf-core/tbprofiler/profile/meta.yml cpan
subworkflows/local/abricate/meta.yml cpan
subworkflows/local/abritamr/meta.yml cpan
subworkflows/local/agrvate/meta.yml cpan
subworkflows/local/amrfinderplus/meta.yml cpan
subworkflows/local/ariba/meta.yml cpan
subworkflows/local/assembler/meta.yml cpan
subworkflows/local/bakta/meta.yml cpan
subworkflows/local/blastn/meta.yml cpan
subworkflows/local/blastp/meta.yml cpan
subworkflows/local/blastx/meta.yml cpan