Add a new static briefing

BNR info-hub Technical Manual

1 Add a new static briefing

1.1 Purpose

This guide explains how to add a new static BNR briefing using the 2023 CVD case-count pilot as the template.

A static briefing is a fixed reporting product that must be reproducible later. It should not silently update when newer data become available.

1.2 Standard pattern

Each static briefing normally has:

one main Stata DO file
one public output bundle
one HTML QMD page
one PDF QMD page
one release catalogue entry

2 Stage 1: Choose the briefing ID

Use a stable ID:

domain_topic_year_version

Examples:

cvd_cases_2023_v1
cvd_case_fatality_2023_v1
cvd_length_of_stay_2023_v1

3 Stage 2: Create the Stata folder

Example:

scripts/stata/briefings/cvd_cases_2023/

Place the main analytical DO file in this folder.

For static briefings, one main analytical DO file per briefing is usually easier to reproduce and hand over.

Shared helpers can live in:

scripts/stata/common/
scripts/stata/ado/
scripts/stata/config/

4 Stage 3: Write the public output bundle

outputs/public/briefings/{briefing_id}/
├── tables/
├── figures/
├── data/
├── meta.yml
└── build.yml

Only approved aggregate outputs, figure-ready public data, public metadata, and public build records should be written to outputs/public/.

5 Stage 4: Create HTML and PDF QMD files

Example:

site/surveillance/cvd/briefings/case-counts.qmd

The HTML page should explain the briefing, embed public figures, summarise findings, and link to outputs.

Example:

site/surveillance/cvd/briefings/case-counts-pdf.qmd

The PDF page should be shorter and more print-oriented than the HTML page.

6 Stage 5: Preview and check

cd C:\yoshimi-hot\output\analyse-bnr\info-hub\site
quarto preview --port 4200

Check:

  • HTML page
  • PDF render
  • release catalogue
  • download links
  • metadata and build files
  • Git status
Back to top