update stan docs

epinowcast · Dec 3, 2024 · 6293762 · 6293762
1 parent 4f080c4
commit 6293762
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 9 deletions.
diff --git a/inst/stan/latent_model/functions.stan b/inst/stan/latent_model/functions.stan
@@ -3,11 +3,11 @@
   *
   * This function is designed to be read into R where:
   * - 'family' is replaced with the target distribution (e.g., 'lognormal')
-  * - 'dpars_A' is replaced with multiple parameters in the format
+  * - 'dpars_A' is replaced with  multiple distribution parameters in the format
   *   "vector|real paramname1, vector|real paramname2, ..." depending on whether
-  *   each parameter has a model. This includes distribution parameters.
-  * - 'dpars_B' is replaced with the same parameters as dpars_A but with window
-  *   indices removed.
+  *   each parameter has a model.
+  * - 'dpars_B' is replaced with the same parameters as dpars_A but
+  *   reparameterised according to the brms parameterisation for Stan.
   *
   * @param y Vector of observed values (delays)
   * @param dpars_A Distribution parameters (replaced via regex)

diff --git a/inst/stan/marginal_model/functions.stan b/inst/stan/marginal_model/functions.stan
@@ -3,11 +3,10 @@
   *
   * This function is designed to be read into R where:
   * - 'family' is replaced with the target distribution (e.g., 'lognormal')
-  * - 'dpars_A' is replaced with multiple parameters in the format
-  *   "vector|real paramname1, vector|real paramname2, ..." depending on whether
-  *   each parameter has a model. This includes distribution parameters.
-  * - 'dpars_B' is replaced with the same parameters as dpars_A but with window
-  *   indices removed.
+  * - 'dpars_A' is replaced with multiple distribution parameters in the format
+  *   "real paramname1, real paramname2, ...".
+  * - 'dpars_B' is replaced with the same parameters as dpars_A but
+  *   reparameterised according to the brms parameterisation for Stan.
   *
   * @param y Real value of observed delay
   * @param dpars_A Distribution parameters (replaced via regex)