diff --git a/DESCRIPTION b/DESCRIPTION index fe21756..a6289bf 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -56,5 +56,5 @@ LazyData: false URL: https://mc-stan.org/posterior/, https://discourse.mc-stan.org/ BugReports: https://github.com/stan-dev/posterior/issues Roxygen: list(markdown = TRUE) -RoxygenNote: 7.3.1 +RoxygenNote: 7.3.2 VignetteBuilder: knitr diff --git a/R/convergence.R b/R/convergence.R index b900c19..e3410f7 100644 --- a/R/convergence.R +++ b/R/convergence.R @@ -16,11 +16,14 @@ #' | [ess_basic()] | Basic version of effective sample size | #' | [ess_bulk()] | Bulk effective sample size | #' | [ess_tail()] | Tail effective sample size | +#' | [ess_mean()] | Effective sample sizes for the mean | +#' | [ess_median()] | Effective sample sizes for the median | #' | [ess_quantile()] | Effective sample sizes for quantiles | -#' | [ess_sd()] | Effective sample sizes for standard deviations | +#' | [ess_sd()] | Effective sample sizes for the standard deviation | #' | [mcse_mean()] | Monte Carlo standard error for the mean | +#' | [mcse_median()] | Monte Carlo standard error for the median | #' | [mcse_quantile()] | Monte Carlo standard error for quantiles | -#' | [mcse_sd()] | Monte Carlo standard error for standard deviations | +#' | [mcse_sd()] | Monte Carlo standard error for the standard deviation | #' | [pareto_khat()] | Pareto khat diagnostic for tail(s) | #' | [pareto_diags()] | Additional diagnostics related to Pareto khat | #' | [rhat_basic()] | Basic version of Rhat | diff --git a/man/diagnostics.Rd b/man/diagnostics.Rd index f2ba499..64b5b8f 100644 --- a/man/diagnostics.Rd +++ b/man/diagnostics.Rd @@ -16,11 +16,14 @@ A list of available diagnostics and links to their individual help pages. \code{\link[=ess_basic]{ess_basic()}} \tab Basic version of effective sample size \cr \code{\link[=ess_bulk]{ess_bulk()}} \tab Bulk effective sample size \cr \code{\link[=ess_tail]{ess_tail()}} \tab Tail effective sample size \cr + \code{\link[=ess_mean]{ess_mean()}} \tab Effective sample sizes for the mean \cr + \code{\link[=ess_median]{ess_median()}} \tab Effective sample sizes for the median \cr \code{\link[=ess_quantile]{ess_quantile()}} \tab Effective sample sizes for quantiles \cr - \code{\link[=ess_sd]{ess_sd()}} \tab Effective sample sizes for standard deviations \cr + \code{\link[=ess_sd]{ess_sd()}} \tab Effective sample sizes for the standard deviation \cr \code{\link[=mcse_mean]{mcse_mean()}} \tab Monte Carlo standard error for the mean \cr + \code{\link[=mcse_median]{mcse_median()}} \tab Monte Carlo standard error for the median \cr \code{\link[=mcse_quantile]{mcse_quantile()}} \tab Monte Carlo standard error for quantiles \cr - \code{\link[=mcse_sd]{mcse_sd()}} \tab Monte Carlo standard error for standard deviations \cr + \code{\link[=mcse_sd]{mcse_sd()}} \tab Monte Carlo standard error for the standard deviation \cr \code{\link[=pareto_khat]{pareto_khat()}} \tab Pareto khat diagnostic for tail(s) \cr \code{\link[=pareto_diags]{pareto_diags()}} \tab Additional diagnostics related to Pareto khat \cr \code{\link[=rhat_basic]{rhat_basic()}} \tab Basic version of Rhat \cr