We discussed in the last meeting that it would be desirable to have a common document in which our model vision is collected and written down.
In my view, this document serves two purposes:
Communication of our vision to the outside world.
An internal basis to understand details and modelling approaches, for example when reviewing code of others or thinking about model specification or extensions.
A few thoughts on this:
Maybe both purposes need different levels of detail
Especially for the latter, I think it would be really helpful if the “small” details like e.g. clear definition of the range of indices, etc. are listed correctly.
It might make sense to create a static version of the document (with a focus on the outside communcation) and a more detailed document that evolves over time (not sure whether this works well though)
- It might also be nice to have some additional documentation how the mathematical description of the model is then finally implemented in STAN-code, but its probably also possible to cover much of this in the code documentation/comments.
Sam has offered to create a draft version of the document, but I thought it might be good to collect some material documenting aspects of the model already in this thread.
We can also use parts of the next meeting to discuss on the overall document/structure, missing parts, and who is willing to contribute at the next meeting!