Issue #376: Add epidist_diagnostics to FAQ (#378)

* Add epidist_diagnostics to FAQ * Put text on new line
epinowcast · Oct 14, 2024 · 339a5ae · 339a5ae
1 parent 4150efa
commit 339a5ae
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/R/diagnostics.R b/R/diagnostics.R
@@ -14,6 +14,7 @@
 #' `max_treedepth`
 #' * `per_at_max_treedepth`: the proportion of samples which attained the
 #' `max_treedepth`
+#'
 #' When the fitting algorithm is not `"sampling"` (see [brms::brm()] for other
 #' possible algorithms) then diagnostics are yet to be implemented.
 #' @param fit A fitted model of class `epidist_fit`

diff --git a/man/epidist_diagnostics.Rd b/man/epidist_diagnostics.Rd
diff --git a/vignettes/faq.Rmd b/vignettes/faq.Rmd
@@ -77,6 +77,12 @@ library(bayesplot)
 mcmc_trace(fit, pars = c("Intercept", "Intercept_sigma"))
 ```
 
+We also provide a function `epidist_diagnostics()` which can be used to obtain common diagnostics used to assess the quality of a fitted model.
+
+```{r message = FALSE}
+epidist_diagnostics(fit)
+```
+
 ## I'd like to run a simulation study
 
 We recommend use of the `purrr` package for running many `epidist` models, for example as a part of a simulation study.