Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.brainworkup.org/llms.txt

Use this file to discover all available pages before exploring further.

Luria Voice depends on a small set of external tools and R packages. The table below lists every dependency, its minimum version, whether it is required or optional, and where to get it. Detailed install instructions follow.

Requirements at a glance

DependencyMinimum versionRequiredNotes
Quarto1.4.0YesBundles Typst — no separate Typst install needed
TypstBundled with QuartoYesDo not install separately unless debugging
R4.2.0YesEarlier versions may work but are untested
dplyrany CRANYesData manipulation
readrany CRANYesCSV / data file reading
hereany CRANYesPortable file paths
yamlany CRANYesYAML front-matter parsing
ggplot2any CRANYesFigure generation
systemfontsany CRANYesFont detection for Typst
cingulateGitHub (brainworkup)YesReport pipeline utilities
OllamaanyNoRequired only for AI narrative generation

Quarto

Quarto ≥ 1.4.0 is required. Quarto 1.4 introduced the Typst output format that Luria Voice depends on. Download the installer for your operating system from quarto.org. After installing, confirm your version:
quarto --version
The output should be 1.4.0 or higher.
Quarto ≥ 1.4.0 ships with Typst embedded. You do not need to install Typst separately. If you have a standalone Typst installation, Quarto uses its own bundled copy and the two will not conflict.

R

R 4.2 or later is recommended. Download from cran.r-project.org. Confirm your version in R:
R.version$major
R.version$minor

R packages

Install all required CRAN packages in a single command:
install.packages(c(
  "dplyr",
  "readr",
  "here",
  "yaml",
  "ggplot2",
  "systemfonts"
))

cingulate (GitHub)

The cingulate package provides the scoring, norming, and domain-assembly pipeline that populates report sections. It is not on CRAN and must be installed from GitHub.
1

Install the remotes package

If you do not already have remotes, install it from CRAN:
install.packages("remotes")
2

Install cingulate from GitHub

remotes::install_github("brainworkup/cingulate")
3

Verify the installation

library(cingulate)
If this command runs without error, cingulate is installed correctly.
remotes::install_github requires an internet connection and access to GitHub. If you are behind a corporate firewall, contact your IT department to allow outbound connections to api.github.com and codeload.github.com.

Ollama (optional)

Ollama enables AI-generated narrative summaries within the report. It is entirely optional — all scoring, tables, and figures render without it. If you want to use AI narratives:
1

Download and install Ollama

Download Ollama from ollama.com and follow the installer for your platform.
2

Pull a model

ollama pull llama3
3

Start the Ollama server before rendering

ollama serve
Ollama must be running on localhost:11434 when you call quarto render. If it is not running, the narrative generation step will time out and log an error.

Installing everything at once

The following block installs all R dependencies in a single session. Run it once after a fresh R installation.
install.packages(c(
  "dplyr",
  "readr",
  "here",
  "yaml",
  "ggplot2",
  "systemfonts",
  "remotes"
))

remotes::install_github("brainworkup/cingulate")
Last modified on May 20, 2026