After feedback from @WardBrian and @mitzimorris, I just merged two new chapters for the User’s Guide right up front in a new introductory part.
- The Stan Ecosystem
- How Stan Works
I’m not sure what the schedule is for releasing doc after we merge, but I think it should be live before our next release.
Chapter (1) tries to explain where everything is, so it’s a rehash of a lot of what’s on our web pages, but spelled out linearly with a bit more explanation.
Chapter (2) is a short overview of how the language works, including variables, blocks, and transforms.
I’m nearly done writing two more chapters:
(n) Structure equation models
(n + 1) Custom constrained parameters
Hopefully (n) is self explanatory. I’m just going over notation and showing how to code in Stan explicitly and with soft zero constraints. I met Ken Bollen (author of the main textbook in the area) at the Modern Modeling Methods conference and have been getting clarification as to whether I correctly understand the notation (that shrinking non-linked correlations to zero still feels wrong but I don’t plan to editorialize in the chapter). Of course, I mention blavaan as the thing to use if your model fits it.
For (n + 1), I’m writing about a bunch of different constraints that we don’t talk about elsehwere.
A. Orthonormal, orthogonal, and rotation matrices
B. Matrices matching specified margins with sum-to-zero matrix (thanks, @spinkney)
C. Fun shapes (from BUGS) like discs, hollow squares, rings, paralellograms, hexagons, etc.
I plan to add Sarah Heaps’s stationarity constraints for vector autoregressive (VAR) models to (n + 1). Then once these are in the User’s Guide, we can move some of them into the language itself. The User’s Guide is like our Boost :-).
I’m open to suggestions on what else to include in both new chapters. I’m particularly looking for constraints that might be widely used or illustrate a general technique.