How paulmndn/bescreen works
BEscreen is a command-line base-editing guide designer. Users provide variants, genes/transcripts, or genomic regions; the CLI selects a design mode, which generates candidate guides and annotations for output. The documented capabilities include rsID and protein-variant input, VEP annotation, BLAST match counts, and guide BAM output. The graph includes all indexed core modules. Some integrations are documented or imported but their invocation is not visible in the excerpts, so those links are marked unverified.
Main entry points: bedesigner.py Variant guides · besaturate.py Gene saturation · beregion.py Region guides · bescreen.py Mode dispatcher
Components 14
CLI and routing
- Mode dispatcher
bescreen/bescreen.py
Guide design
- Variant guides
bescreen/bedesigner.py - Gene saturation
bescreen/besaturate.py - Region guides
bescreen/beregion.py
Variant annotation
- VEP annotation
bescreen/get_vep.py - dbSNP lookup and database builder
bescreen/dbsnp_sqlite3.py - Guide BLAST matching
bescreen/blast_guides.py
Shared utilities
- Sequence and annotation utilities
bescreen/shared.py - Protein variant conversion
bescreen/protein_variant.py
Other components
- CLI user
- Reference genome and annotations
- Ensembl VEP
- NCBI BLAST tools
- Guide tables and BAM
Connections 23
- CLI user → Mode dispatcher: provides input
README.md - Mode dispatcher → Variant guides: routes variants
README.md - Mode dispatcher → Gene saturation: routes genes
README.md - Mode dispatcher → Region guides: routes regions
README.md - Variant guides → dbSNP lookup and database builder: queries rsIDs
bescreen/bedesigner.py - Variant guides → Protein variant conversion: converts protein input
bescreen/bedesigner.py - Variant guides → Sequence and annotation utilities: uses utilities
bescreen/bedesigner.py - Gene saturation → Sequence and annotation utilities: uses utilities
bescreen/besaturate.py - Region guides → Sequence and annotation utilities: uses utilities
bescreen/beregion.py - Variant guides → VEP annotation: requests annotations
bescreen/bedesigner.py - Gene saturation → VEP annotation: requests annotations
bescreen/besaturate.py - Region guides → VEP annotation: requests annotations
bescreen/beregion.py - VEP annotation → Ensembl VEP: runs offline
bescreen/get_vep.py - Variant guides → Guide BLAST matching: checks guide matches
bescreen/bedesigner.py - Gene saturation → Guide BLAST matching: checks guide matches
bescreen/besaturate.py - Region guides → Guide BLAST matching: checks guide matches
bescreen/beregion.py - Guide BLAST matching → NCBI BLAST tools: runs search
bescreen/blast_guides.py - Variant guides → Reference genome and annotations: reads genome
- Gene saturation → Reference genome and annotations: reads genome
- Region guides → Reference genome and annotations: reads genome
- Variant guides → Guide tables and BAM: writes guides and BAM
bescreen/bedesigner.py - Gene saturation → Guide tables and BAM: writes guides and BAM
bescreen/besaturate.py - Region guides → Guide tables and BAM: writes guides and BAM
bescreen/beregion.py