Housekeeping

[pr130]

A general Housekeeping Epic. here we can dump overarching / meta tasks related to:

• package structure
• CI/CD
• refactoring
• documentation
• testing

[MKyhos]

Regarding package documentation and coding style, given that we might have larger method functions for classes: In cmdstanr, the authors decided to rely on the $set() way in R6 to add (large) methods not during the initial class definition, but afterwards. They argue, that this is better readable.

However, as they also acknowledge, currently roxygen is not well supporting documentation for methods added via $set(), and thus the UX with the documentation is not so good (therefore, they consider to change their code structure).

See here for the relevant roxygen issue and discussion: https://github.com/r-lib/roxygen2/issues/931