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 gives you a pre-structured Quarto project wired to a Typst PDF template. This guide walks you through every step from scaffolding a new report to opening the finished PDF — no prior Quarto or Typst experience required.

​
Prerequisites

Before you start, make sure the following are installed:
  • Quarto 1.4 or later
  • R 4.3 or later with the cingulate package (remotes::install_github("brainworkup/cingulate"))
  • A PDF viewer (any will do)
1

Scaffold the template

Run the following command in the directory where you want to create your report project. Quarto will download the neurotyp-adult extension and copy the starter files into a new folder.
quarto use template brainworkup/neurotyp-adult
When prompted, enter a directory name for your project (for example, doe-jane-2025). After the command completes, your project folder will contain:
doe-jane-2025/
├── template.qmd          # Main report document
├── _quarto.yml           # Quarto project settings
├── _brand/
│   └── _brand.yml        # Colors and typography
├── _domains_to_include.qmd
└── _extensions/
    └── neurotyp-adult/   # Typst template files
2

Open template.qmd

Open template.qmd in your editor. The top of the file contains the YAML front matter block, which controls all patient metadata and report settings.You will see placeholder values like this:
---
title: NEUROCOGNITIVE EXAMINATION
patient: Doe
name: Doe, Jane
dob: "1980-01-15"
age: 45
doe: "2025-03-10"
doe2: "2025-03-11"
doe3: "2025-03-12"
date_of_report: last-modified
case_number: "2025-001"
---
Replace each placeholder with the actual patient information for this evaluation. See Configure patient metadata for a full reference of every field.
3

Configure front matter for your patient

Update the front matter with accurate case details. A completed example for a real evaluation looks like this:
---
title: NEUROCOGNITIVE EXAMINATION
patient: Rivera
name: Rivera, Maria
dob: "1978-06-22"
age: 46
doe: "2025-04-07"
date_of_report: last-modified
case_number: "2025-042"
---
If the evaluation took place across multiple sessions, add doe2 and optionally doe3 fields. Only include the fields that correspond to actual evaluation dates.
4

Add behavioral observations

Scroll down in template.qmd to find the Behavioral Observations section. Replace the placeholder text with your own clinical observations.
## Behavioral Observations

Maria presented as cooperative and engaged throughout both evaluation sessions.
She arrived on time, was appropriately dressed, and maintained adequate eye
contact. Speech was fluent and coherent. She reported mild anxiety at the
start of testing, which appeared to diminish as the session progressed.
Effort was judged to be adequate based on embedded validity indicators.
Write this section directly in the .qmd file using plain Markdown. You do not need any special Quarto or R syntax here — just prose.
5

Select cognitive domains to include

Open _domains_to_include.qmd. This file controls which domain-specific score sections appear in the report. Add or remove {{< include >}} directives to match the tests you administered.
{{< include _neurocognitive.qmd >}}
{{< include _verbal-memory.qmd >}}
{{< include _attention.qmd >}}
For a detailed explanation of how domain partials work, see Add cognitive domain findings.
6

Render the report to PDF

From the terminal, navigate to your project directory and run:
quarto render template.qmd --to neurotyp-adult-typst
Quarto compiles the .qmd file, runs all R code chunks, passes the output to the Typst template, and produces a PDF alongside your source file.
quarto render template.qmd --to neurotyp-adult-typst
Rendering requires all referenced domain partial files to exist. If _domains_to_include.qmd references a file that does not exist in the project directory, Quarto will throw an error and stop.
7

Review the output PDF

Open template.pdf in your PDF viewer. Check the following before submitting or printing:
  • Patient name, date of birth, and case number are correct on page 1
  • The CONFIDENTIAL header on pages 2 and beyond shows the correct patient last name
  • All evaluation dates are accurate
  • Score tables and figures rendered correctly in each domain section
  • The SIRF section (Summary, Impressions, Recommendations & Findings) is complete
If you need to make corrections, edit template.qmd and re-run quarto render.

​
Next steps

Last modified on May 18, 2026