diff --git a/R/diagnostics.R b/R/diagnostics.R index fef867fdd..3be86094b 100644 --- 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 index 7e9bf9838..eb7de03ac 100644 --- a/man/epidist_diagnostics.Rd +++ b/man/epidist_diagnostics.Rd @@ -25,8 +25,10 @@ transitions \code{max_treedepth} \item \code{per_at_max_treedepth}: the proportion of samples which attained the \code{max_treedepth} +} +} +\details{ When the fitting algorithm is not \code{"sampling"} (see \code{\link[brms:brm]{brms::brm()}} for other possible algorithms) then diagnostics are yet to be implemented. } -} \concept{diagnostics} diff --git a/vignettes/faq.Rmd b/vignettes/faq.Rmd index c6c48628d..869c9b8d9 100644 --- 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.