Sign inSign up

bbeckleyhub/enteroscope

By bbeckleyhub

•Updated 3 months ago

🔬 EnteroScope – Docker Image

Image
0

140

bbeckleyhub/enteroscope repository overview

⁠🔬 EnteroScope – Docker Image

Complete CREC (Carbapenem‑Resistant Enterobacter cloacae) genomic analysis in minutes — not hours

Docker Pulls Docker Image Size Docker Version License GitHub Stars


⁠🚀 Quick Start

# Pull the image
docker pull bbeckleyhub/enteroscope:latest

# Run analysis on all .fasta files in current directory
docker run --rm \
  -v $(pwd):/data \
  -w /data \
  bbeckleyhub/enteroscope:latest \
  -i "*.fna" -o results --threads 4

Note: The image comes with pre‑configured ABRicate and AMRfinderPlus databases – no extra setup required. Just pull and run!


⁠📋 Table of Contents


⁠📖 Usage Examples

⁠Basic single genome analysis
docker run --rm \
  -v $(pwd):/data \
  -w /data \
  bbeckleyhub/enteroscope:latest \
  -i genome.fna -o results
⁠Batch processing with glob pattern
docker run --rm \
  -v $(pwd):/data \
  -w /data \
  bbeckleyhub/enteroscope:latest \
  -i "*.fna" -o batch_results --threads 16
⁠Skip specific modules (faster test run)
docker run --rm \
  -v $(pwd):/data \
  -w /data \
  bbeckleyhub/enteroscope:latest \
  -i "*.fna" -o quick_test --skip-abricate --skip-amr
⁠Custom thresholds for AMR & ABRicate
docker run --rm \
  -v $(pwd):/data \
  -w /data \
  bbeckleyhub/enteroscope:latest \
  -i "*.fna" -o custom_results \
  --amr-min-identity 0.95 --amr-min-coverage 0.9 \
  --abricate-min-identity 85 --abricate-min-coverage 85
⁠Force AMR database update before analysis
docker run --rm \
  -v $(pwd):/data \
  -w /data \
  bbeckleyhub/enteroscope:latest \
  -i "*.fna" -o results --amr-force-update
⁠Update AMR database (standalone)
docker run --rm bbeckleyhub/enteroscope:latest --update-amr-db

⁠⚙️ Command‑line Options

FlagDescription
-i, --inputInput FASTA file(s) – supports glob patterns (e.g., "*.fna")
-o, --outputOutput directory for all results
-t, --threadsNumber of CPU threads (default: 2)
--versionShow version and exit
--update-amr-dbUpdate AMRfinderPlus database and exit
--force-update-amr-dbForce complete AMR database update and exit
--skip-qcSkip FASTA QC
--skip-mlstSkip MLST
--skip-abricateSkip ABRicate
--skip-amrSkip AMRfinderPlus
--skip-summarySkip gene‑centric summary report
--amr-min-identityMinimum identity for AMR hits (0..1)
--amr-min-coverageMinimum coverage for AMR hits (0..1)
--skip-amr-mutationsDisable point mutation reporting (enabled by default)
--amr-force-updateForce update AMR database before analysis
--abricate-min-identityMinimum identity for ABRicate hits (0‑100, default: 80)
--abricate-min-coverageMinimum coverage for ABRicate hits (0‑100, default: 80)
--keep-tempKeep temporary directories (debugging)
--clean-outputDelete output directory before analysis

Supported FASTA formats: .fna, .fasta, .fa, .fsa


⁠📁 Output Structure

Below is the actual output layout generated by EnteroScope. All paths are relative to your specified output directory (-o).

Enteroscope_results/
├── fasta_qc_results/                          # QC per sample + summary
│   ├── {sample}_fasta_qc_report.html/json
│   └── Enteroscope_FASTA_QC_summary.html/json/tsv
│
├── mlst_results/                              # MLST per sample + summary
│   ├── {sample}/mlst_report.html/json/txt/tsv
│   └── mlst_summary.html/csv/json
│
├── enteroscope_abricate_results/              # ABRicate per sample & per database summaries
│   ├── {sample}/abricate_{db}_report.html/txt (for each db)
│   └── enteroscope_{db}_summary_report.html/json/tsv (per database)
│
├── enteroscope_amrfinder_results/             # AMRfinder per sample + mutation summary
│   ├── {sample}/{sample}_amrfinder_report.html/json/txt
│   ├── {sample}/{sample}_mutations.html/tsv
│   ├── enteroscope_amrfinder_summary_report.html
│   └── mutation_summary.html/tsv (gene‑centric mutation table)
│
├── ENTERO_ULTIMATE_REPORTS/                   # Final interactive dashboard
│   ├── enteroscope_ultimate_report.html       ← Main interactive report
│   ├── enteroscope_ultimate_report.json       # AI‑ready full data
│   ├── amr_genes.csv
│   ├── virulence_genes.csv
│   ├── bacmet_genes.csv
│   ├── plasmid_markers.csv
│   ├── mutations.csv                          # Exported point mutations
│   ├── enterobacter_samples.csv
│   └── mlst_distribution.csv
│
└── enteroscope_run.log                        # Detailed log file
⁠📌 Key files to open
  • Ultimate interactive report:
    ENTERO_ULTIMATE_REPORTS/enteroscope_ultimate_report.html
  • AI‑ready data:
    ENTERO_ULTIMATE_REPORTS/enteroscope_ultimate_report.json

⁠🔍 Core Modules

ModulePurposeOutputs
FASTA QCAssembly quality metricsN50, GC%, contig stats, HTML/TSV/JSON
MLSTSequence typing (7 genes)ST, allele profile, summary table
AMRfinderPlusResistance genes & point mutationsRisk categories, gene prevalence, mutations
ABRicateMulti‑database screening (9 DBs)Virulence, resistance, plasmids, biocides
BACMET2Biocide & heavy metal resistanceqac, mer, ars, etc.
PlasmidFinderReplicon typingInc groups, Col‑like plasmids
Ultimate ReporterGene‑centric integrationInteractive HTML, CSV exports, mutation tab

⁠🐳 Singularity (HPC)

For HPC clusters where Docker is not available:

# Pull directly from Docker Hub
singularity pull enteroscope.sif docker://bbeckleyhub/enteroscope:latest

# Run with writable tmpfs (essential for EnteroScope)
singularity run --writable-tmpfs -B $(pwd):/data enteroscope.sif \
  -i "/data/*.fna" -o /data/output --threads 8

All output files will be owned by your HPC user – no sudo chown needed.


⁠📚 Citation

If you use EnteroScope in your research, please cite:

@software{beckley2026enteroscope,
  author = {Brown Beckley},
  title = {EnteroScope: A Tailored Computational Workflow Enabling Rapid, User-Friendly Genotyping and Epidemiological Surveillance of the Enterobacter cloacae Complex},
  year = {2026},
  publisher = {GitHub},
  url = {https://github.com/bbeckley-hub/enteroscope},
  version = {1.1.0}
}

Integrated tools: Please also cite MLST, ABRicate, AMRFinderPlus, PlasmidFinder, BACMET2, and others (full list in the repository).


⁠🤝 Support & Contributions


⁠📄 License

The EnteroScope pipeline code is licensed under the MIT License. Third‑party tools are used under their respective licenses.


⭐ If you find EnteroScope useful, please star the repository! ⭐

Tag summary

Content type

Image

Digest

sha256:2c4518739…

Size

1.3 GB

Last updated

3 months ago

docker pull bbeckleyhub/enteroscope