Skip to content

Add Stan model index reference page - #612

Merged
seabbs merged 1 commit into
mainfrom
docs/544-model-index
May 11, 2026
Merged

Add Stan model index reference page#612
seabbs merged 1 commit into
mainfrom
docs/544-model-index

Conversation

@sbfnk

@sbfnk sbfnk commented May 5, 2026

Copy link
Copy Markdown
Contributor

This PR closes #544.

Adds reference/model-index.qmd: a single page that prints the source of every Stan model in the package, grouped by the session in which it is first introduced. Reading them in order makes it easier to see how the models build up across the course (the ESPIDAM 2025 participant request).

Implementation notes:

  • Programmatic — model code is read from nfidd_stan_path() at render time, so the page always shows the current Stan source.
  • A stopifnot(setequal(unlist(session_models), nfidd_stan_models())) guard fails the render (and thus the deploy) if a new .stan file is added without being placed in the index, or vice versa.
  • Picks up the auto-sidebar via _quarto.yml contents: "reference/*.qmd". Order 12 puts it just after using-our-stan-models (11).

Co-authored-by: sbfnk <sebastian.funk@lshtm.ac.uk>
@sbfnk
sbfnk marked this pull request as ready for review May 8, 2026 08:02
@sbfnk
sbfnk requested review from kathsherratt and seabbs and removed request for seabbs May 8, 2026 08:03
@seabbs
seabbs added this pull request to the merge queue May 11, 2026
Merged via the queue into main with commit e10b10f May 11, 2026
8 checks passed
@seabbs
seabbs deleted the docs/544-model-index branch May 11, 2026 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

model index

3 participants