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

* Add epidist_diagnostics to FAQ

* Put text on new line

Author: athowes

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`

man/epidist_diagnostics.Rd

@@ -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.