Complete CREC (Carbapenem‑Resistant Enterobacter cloacae) genomic analysis in minutes — not hours
# 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!
docker run --rm \
-v $(pwd):/data \
-w /data \
bbeckleyhub/enteroscope:latest \
-i genome.fna -o results
docker run --rm \
-v $(pwd):/data \
-w /data \
bbeckleyhub/enteroscope:latest \
-i "*.fna" -o batch_results --threads 16
docker run --rm \
-v $(pwd):/data \
-w /data \
bbeckleyhub/enteroscope:latest \
-i "*.fna" -o quick_test --skip-abricate --skip-amr
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
docker run --rm \
-v $(pwd):/data \
-w /data \
bbeckleyhub/enteroscope:latest \
-i "*.fna" -o results --amr-force-update
docker run --rm bbeckleyhub/enteroscope:latest --update-amr-db
| Flag | Description |
|---|---|
-i, --input | Input FASTA file(s) – supports glob patterns (e.g., "*.fna") |
-o, --output | Output directory for all results |
-t, --threads | Number of CPU threads (default: 2) |
--version | Show version and exit |
--update-amr-db | Update AMRfinderPlus database and exit |
--force-update-amr-db | Force complete AMR database update and exit |
--skip-qc | Skip FASTA QC |
--skip-mlst | Skip MLST |
--skip-abricate | Skip ABRicate |
--skip-amr | Skip AMRfinderPlus |
--skip-summary | Skip gene‑centric summary report |
--amr-min-identity | Minimum identity for AMR hits (0..1) |
--amr-min-coverage | Minimum coverage for AMR hits (0..1) |
--skip-amr-mutations | Disable point mutation reporting (enabled by default) |
--amr-force-update | Force update AMR database before analysis |
--abricate-min-identity | Minimum identity for ABRicate hits (0‑100, default: 80) |
--abricate-min-coverage | Minimum coverage for ABRicate hits (0‑100, default: 80) |
--keep-temp | Keep temporary directories (debugging) |
--clean-output | Delete output directory before analysis |
Supported FASTA formats: .fna, .fasta, .fa, .fsa
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
ENTERO_ULTIMATE_REPORTS/enteroscope_ultimate_report.htmlENTERO_ULTIMATE_REPORTS/enteroscope_ultimate_report.json| Module | Purpose | Outputs |
|---|---|---|
| FASTA QC | Assembly quality metrics | N50, GC%, contig stats, HTML/TSV/JSON |
| MLST | Sequence typing (7 genes) | ST, allele profile, summary table |
| AMRfinderPlus | Resistance genes & point mutations | Risk categories, gene prevalence, mutations |
| ABRicate | Multi‑database screening (9 DBs) | Virulence, resistance, plasmids, biocides |
| BACMET2 | Biocide & heavy metal resistance | qac, mer, ars, etc. |
| PlasmidFinder | Replicon typing | Inc groups, Col‑like plasmids |
| Ultimate Reporter | Gene‑centric integration | Interactive HTML, CSV exports, mutation tab |
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 chownneeded.
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).
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! ⭐
Content type
Image
Digest
sha256:2c4518739…
Size
1.3 GB
Last updated
2 months ago
docker pull bbeckleyhub/enteroscope