How djw533/hamburger works
Project type and purpose
• This is a command-line bioinformatics pipeline (“hamburger”) written in Python 3 (core logic) and R (T6SS filtering & plotting).
• It takes GFF3/FASTA files plus concatenated HMM profiles, searches genomes for co-localized gene clusters (especially T6SS loci), then filters, subtypes, and outputs results (tables, GFFs, iTOL inputs).
Main components
a. CLI Front-End (scripts/hamburger.py)
• Parses arguments, orchestrates workflow.
b. Python Core Package (hamburger/)
• I/O & parsing: fasta_parsing.py, gff_parsing.py
• HMM search: hmmer_functions.py, run_prodigal.py
• Cluster extraction & cleanup: extract.py, clean.py
• Filtering & grouping: filter.py, filter_t6_types.py, istarmap.py
• T6SS-specific utilities: tool_check.py, search.py
c. HMM Model Store (models/)
• Pre-built .hmm files (T6SS core, accessory, individual sub-units)
d. R Subtyping & Visualization (scripts/*.R)
• install_R_packages.R, filter_t6_types.R, post_hamburger_t6SS_search.R
e. Reference Sets (t6ss_reference_set/)
• FASTA alignments, subtype tables, phylogenetic trees
f. External Tools
• HMMER, Prodigal, Muscle, FastTree, R (+ libraries), Python libs (Biopython, pandas)
Relationships & data flow
1) User invokes CLI → passes GFF/FASTA + HMM profiles →
2) Python parses inputs → (optional) runs Prodigal →
3) Python calls HMMER via hmmer_functions → uses models/*.hmm →
4) extract.py identifies candidate clusters → clean.py refines results →
5) filter.py / filter_t6_types.py apply generic filters →
6) If ‑t flag: istarmap.py & search.py perform T6SS subtyping →
7) Python writes intermediate outputs (CSV, GFF) →
8) R scripts consume those outputs for plots / iTOL files →
9) Final outputs: annotated GFFs, summary tables, phylogenetic context files.
Architectural patterns & principles
• Modular pipeline: clearly separated parsing, search, filtering, subtyping, visualization.
• Data-driven design: HMM models and reference sets externalized in “models/” and “t6ss_reference_set/”.
• Single-responsibility modules: each .py/.R file has a distinct task.
• CLI orchestration layer decoupled from core logic.
Essential elements
• On reusable resources (models/, reference sets).