# gaius-augustus/braker architecture

> Architecture diagram of the GitHub repository gaius-augustus/braker, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gaius-augustus/braker
- Repository: https://github.com/gaius-augustus/braker

## Overview

BRAKER is a command-line genome-annotation pipeline: users provide a genome and RNA-seq and/or protein evidence, and receive predicted gene annotations. The README describes automated training and prediction with GeneMark and AUGUSTUS, with extrinsic evidence informing predictions; it also describes BRAKER3's highly supported combined gene set. The graph includes these documented stages and substantial indexed scripts. Source excerpts do not show how the main Perl pipeline dispatches helpers, so those connections are omitted.

Main entry points: [`scripts/braker.pl`](https://github.com/gaius-augustus/braker/blob/master/scripts/braker.pl) (BRAKER pipeline)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["Annotation workflow"]
  node_braker["BRAKER pipeline<br/>[braker.pl]"]
  node_genome["Genome sequence"]
  node_evidence["RNA-seq / proteins"]
  node_annotation["Gene annotations"]
end

subgraph group_prediction["Gene prediction"]
  node_genemark["GeneMark training"]
  node_augustus["AUGUSTUS prediction"]
end

subgraph group_utilities["Sequence and evidence utilities"]
  node_gc["GC content range<br/>[get_gc_content.py]"]
  node_etp_hints["ETP hint extraction<br/>[get_etp_hints.py]"]
  node_training_genes["Training gene selection"]
  node_genemark_sort["GeneMark sorting<br/>[sortGeneMark.py]"]
end

subgraph group_refinement["Model refinement"]
  node_stringtie_utr["UTR decoration<br/>[stringtie2utr.py]"]
  node_busco_rename["BUSCO ID normalization"]
end

node_user(("Researcher"))

node_user -->|"runs"| node_braker
node_user -->|"provides"| node_genome
node_user -->|"provides"| node_evidence
node_braker -->|"trains"| node_genemark
node_braker -->|"trains and predicts"| node_augustus
node_braker -->|"produces"| node_annotation
node_genemark -->|"contributes predictions"| node_annotation
node_augustus -->|"contributes predictions"| node_annotation
node_evidence -->|"informs training and prediction"| node_braker
node_genome -->|"input sequence"| node_braker

click node_braker "https://github.com/gaius-augustus/braker/blob/master/scripts/braker.pl"
click node_gc "https://github.com/gaius-augustus/braker/blob/master/scripts/get_gc_content.py"
click node_etp_hints "https://github.com/gaius-augustus/braker/blob/master/scripts/get_etp_hints.py"
click node_training_genes "https://github.com/gaius-augustus/braker/blob/master/scripts/ensure_n_training_genes.py"
click node_genemark_sort "https://github.com/gaius-augustus/braker/blob/master/scripts/sortGeneMark.py"
click node_stringtie_utr "https://github.com/gaius-augustus/braker/blob/master/scripts/stringtie2utr.py"
click node_busco_rename "https://github.com/gaius-augustus/braker/blob/master/scripts/dev/rename_busco_genes.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_braker,node_genome,node_evidence,node_annotation toneBlue
class node_genemark,node_augustus toneAmber
class node_gc,node_etp_hints,node_training_genes,node_genemark_sort toneMint
class node_stringtie_utr,node_busco_rename toneRose
class node_user toneIndigo
```

## Components

### Annotation workflow

- [BRAKER pipeline](https://github.com/gaius-augustus/braker/blob/master/scripts/braker.pl): `scripts/braker.pl`
- **Genome sequence**
- **RNA-seq / proteins**
- **Gene annotations**

### Gene prediction

- **GeneMark training**
- **AUGUSTUS prediction**

### Sequence and evidence utilities

- [GC content range](https://github.com/gaius-augustus/braker/blob/master/scripts/get_gc_content.py): `scripts/get_gc_content.py`
- [ETP hint extraction](https://github.com/gaius-augustus/braker/blob/master/scripts/get_etp_hints.py): `scripts/get_etp_hints.py`
- [Training gene selection](https://github.com/gaius-augustus/braker/blob/master/scripts/ensure_n_training_genes.py): `scripts/ensure_n_training_genes.py`
- [GeneMark sorting](https://github.com/gaius-augustus/braker/blob/master/scripts/sortGeneMark.py): `scripts/sortGeneMark.py`

### Model refinement

- [UTR decoration](https://github.com/gaius-augustus/braker/blob/master/scripts/stringtie2utr.py): `scripts/stringtie2utr.py`
- [BUSCO ID normalization](https://github.com/gaius-augustus/braker/blob/master/scripts/dev/rename_busco_genes.py): `scripts/dev/rename_busco_genes.py`

### Other components

- **Researcher**

## Connections

- Researcher → BRAKER pipeline: runs (evidence: `README.md`)
- Researcher → Genome sequence: provides (evidence: `README.md`)
- Researcher → RNA-seq / proteins: provides (evidence: `README.md`)
- BRAKER pipeline → GeneMark training: trains (evidence: `README.md`)
- BRAKER pipeline → AUGUSTUS prediction: trains and predicts (evidence: `README.md`)
- BRAKER pipeline → Gene annotations: produces (evidence: `README.md`)
- GeneMark training → Gene annotations: contributes predictions (evidence: `README.md`)
- AUGUSTUS prediction → Gene annotations: contributes predictions (evidence: `README.md`)
- RNA-seq / proteins → BRAKER pipeline: informs training and prediction (evidence: `README.md`)
- Genome sequence → BRAKER pipeline: input sequence (evidence: `README.md`)
