# Getting started

ry is a toolchain for R, written in Rust. It checks, formats and runs the R code you already have,
without changes, and its checker finds problems without running the code.

## What ry does

- **Check**: unresolved names, syntax errors, lints and, once you switch typing on, type errors.
- **Format**: `ry fmt`, one style for every file.
- **Edit**: hover, completion, rename, go to definition and quick fixes in any LSP editor.
- **Load**: `ry load` and the `ry run` console reload a package after an edit in milliseconds.
- **Run**: `ry run` runs R on ry's own runtime, with a JIT, records, tagged unions and a typed
  table.

How ry's runtime compares with GNU R, as each benchmark suite's geometric mean:

| Suite | What it is | ry vs GNU R | ry typed |
| --- | --- | ---: | ---: |
| Public R JIT benchmarks | 54 standard programs from R compiler research (Ř, rcp) | 3.76x | 20x |
| Package test suites | 26 pinned CRAN packages, each running its own test suite | 2.75x | not typed |
| Numeric kernels (ours) | 16 small programs we wrote whose time goes into loops, recursion and arithmetic on numbers | 6.06x | 26x |
| Application workloads (ours) | 15 programs we wrote in the shape of package and business code: calls, dispatch, conditions, records, tables | 3.77x | 72x |

Geometric means of the speed-ups over GNU R; above 1x means ry is faster.

- Public R JIT benchmarks: measured on 2026-11-16 on the ry 0.5.0 release archive (sha256 575ad8ad890b) with GNU R 4.6.2 on Intel(R) Xeon(R) Processor @ 2.10GHz, 4 cores, Linux 6.18.44-fc-v470; 10 paired rounds.
- Package test suites: measured on 2026-11-16 on the ry 0.5.0 release archive (sha256 575ad8ad890b) with GNU R 4.6.2 on Intel(R) Xeon(R) Processor @ 2.10GHz, 4 cores, Linux 6.18.44-fc-v509; 10 paired rounds.
- Benchmark code bases: measured on 2026-11-17 on the ry 0.5.0 release archive (sha256 575ad8ad890b) with GNU R 4.6.2 on Intel(R) Xeon(R) Processor @ 2.10GHz, 4 cores, Linux 6.18.44-fc-v553; 10 paired rounds.
- Numeric kernels (ours): measured on 2026-11-17 on the ry 0.5.0 release archive (sha256 575ad8ad890b) with GNU R 4.6.2 on Intel(R) Xeon(R) Processor @ 2.10GHz, 4 cores, Linux 6.18.44-fc-v509; 10 paired rounds.
- Application workloads (ours): measured on 2026-11-17 on the ry 0.5.0 release archive (sha256 575ad8ad890b) with GNU R 4.6.2 on Intel(R) Xeon(R) Processor @ 2.10GHz, 4 cores, Linux 6.18.44-fc-v509; 10 paired rounds.

[Benchmarks](/benchmarks.md) explains how each suite is built and measured, and shows every program.

## Next steps

1. [Install ry](/installation.md) and set up your editor.
2. [Adopt ry](/guide.md) on a project, in four steps from plain R to fully typed code.
3. Take the [language tour](/ry.md) for every feature on one page.

ry is in beta. The checker, formatter, language server and package loader are ready for daily use,
and diagnostic codes, `ry.toml` keys and the JSON output are stable. ry's runtime is incomplete:
code that needs something it lacks stops with an error that names it, and `ry R` runs the same code
on GNU R.
