diff --git a/DESCRIPTION b/DESCRIPTION index e2c9418..dc576a5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -81,4 +81,4 @@ License: GPL-3 Encoding: UTF-8 Additional_repositories: http://bbolker.github.io/drat VignetteBuilder: knitr -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.1 diff --git a/man/brms_tidiers.Rd b/man/brms_tidiers.Rd index eb63809..7c082c7 100644 --- a/man/brms_tidiers.Rd +++ b/man/brms_tidiers.Rd @@ -15,6 +15,8 @@ conf.int = TRUE, conf.level = 0.95, conf.method = c("quantile", "HPDinterval"), + rhat = FALSE, + ess = FALSE, fix.intercept = TRUE, exponentiate = FALSE, ... @@ -52,6 +54,12 @@ Only used if \code{conf.int = TRUE}.} \item{conf.method}{method for computing confidence intervals ("quantile" or "HPDinterval")} +\item{rhat}{whether to calculate the *Rhat* convergence metric +(\code{FALSE} by default)} + +\item{ess}{whether to calculate the *effective sample size* (ESS) convergence metric +(\code{FALSE} by default)} + \item{fix.intercept}{rename "Intercept" parameter to "(Intercept)", to match behaviour of other model types?} @@ -127,6 +135,9 @@ At present, the components of parameter estimates are separated by parsing the c tidy(fit, effects = "fixed", conf.method="HPDinterval") tidy(fit, effects = "ran_vals") tidy(fit, effects = "ran_pars", robust = TRUE) + if (require("posterior")) { + tidy(fit, effects = "ran_pars", rhat = TRUE, ess = TRUE) + } # glance method glance(fit) ## this example will give a warning that it should be run with