# fgazzelloni/typer architecture

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

- Interactive diagram: https://gitdiagram.com/fgazzelloni/typer
- Repository: https://github.com/fgazzelloni/typer

## Overview

typeR is an R package for presenting code through simulated typing. The principal workflow is a user supplying an R, R Markdown, or Quarto file to either display its typing animation with typeR or type and execute it with typeRun. The implementation tree also contains typing and typeRun utility modules, but no source excerpts show their callers or internal behavior, so their relationships are left unspecified. Edges below reflect only capabilities documented in the README.

Main entry points: [`R/typeR.R`](https://github.com/fgazzelloni/typer/blob/main/R/typeR.R) (Typing display), [`R/typeRun.R`](https://github.com/fgazzelloni/typer/blob/main/R/typeRun.R) (Type and execute)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_presentation["Code presentation"]
  node_type_r["Typing display<br/>[typeR.R]"]
  node_type_run["Type and execute<br/>[typeRun.R]"]
end

subgraph group_runtime["Runtime modules"]
  node_typing_utils["Typing utilities<br/>[utils-typing.R]"]
  node_run_utils["Execution utilities<br/>[utils-typerun.R]"]
end

node_user(("Presenter"))
node_script["Code file"]

node_user -->|"requests display"| node_type_r
node_script -->|"provides code"| node_type_r
node_user -->|"requests execution"| node_type_run
node_script -->|"provides code"| node_type_run

click node_type_r "https://github.com/fgazzelloni/typer/blob/main/R/typeR.R"
click node_type_run "https://github.com/fgazzelloni/typer/blob/main/R/typeRun.R"
click node_typing_utils "https://github.com/fgazzelloni/typer/blob/main/R/utils-typing.R"
click node_run_utils "https://github.com/fgazzelloni/typer/blob/main/R/utils-typerun.R"

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_type_r,node_type_run toneBlue
class node_typing_utils,node_run_utils toneAmber
class node_user,node_script toneIndigo
```

## Components

### Code presentation

- [Typing display](https://github.com/fgazzelloni/typer/blob/main/R/typeR.R): `R/typeR.R`
- [Type and execute](https://github.com/fgazzelloni/typer/blob/main/R/typeRun.R): `R/typeRun.R`

### Runtime modules

- [Typing utilities](https://github.com/fgazzelloni/typer/blob/main/R/utils-typing.R): `R/utils-typing.R`
- [Execution utilities](https://github.com/fgazzelloni/typer/blob/main/R/utils-typerun.R): `R/utils-typerun.R`

### Other components

- **Presenter**
- **Code file**

## Connections

- Presenter → Typing display: requests display (evidence: `README.md`)
- Code file → Typing display: provides code (evidence: `README.md`)
- Presenter → Type and execute: requests execution (evidence: `README.md`)
- Code file → Type and execute: provides code (evidence: `README.md`)
