From 8adfe47fba2c6b37a7f82b56c57016b46decdaeb Mon Sep 17 00:00:00 2001 From: n-kall Date: Wed, 15 Nov 2023 18:43:55 +0200 Subject: [PATCH] change default for r_eff in pareto_smooth --- man-roxygen/args-pareto.R | 2 +- man/pareto_diags.Rd | 2 +- man/pareto_khat.Rd | 2 +- man/pareto_smooth.Rd | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/man-roxygen/args-pareto.R b/man-roxygen/args-pareto.R index 98940a7e..db89f30c 100644 --- a/man-roxygen/args-pareto.R +++ b/man-roxygen/args-pareto.R @@ -14,7 +14,7 @@ #' length(x) / 5 otherwise (see Appendix H in Vehtari et #' al. (2022)). #' @param r_eff (numeric) relative effective sample size estimate. If -#' `r_eff` is omitted, it will be calculated assuming the draws are +#' `r_eff` is NULL, it will be calculated assuming the draws are #' from MCMC. Default is 1. #' @param verbose (logical) Should diagnostic messages be printed? If #' `TRUE`, messages related to Pareto diagnostics will be diff --git a/man/pareto_diags.Rd b/man/pareto_diags.Rd index 7f850ac2..187a1237 100644 --- a/man/pareto_diags.Rd +++ b/man/pareto_diags.Rd @@ -40,7 +40,7 @@ pareto_diags(x, ...) The default is \code{"both"}.} \item{r_eff}{(numeric) relative effective sample size estimate. If -\code{r_eff} is omitted, it will be calculated assuming the draws are +\code{r_eff} is NULL, it will be calculated assuming the draws are from MCMC. Default is 1.} \item{ndraws_tail}{(numeric) number of draws for the tail. If diff --git a/man/pareto_khat.Rd b/man/pareto_khat.Rd index cd5c11a9..0d844580 100644 --- a/man/pareto_khat.Rd +++ b/man/pareto_khat.Rd @@ -40,7 +40,7 @@ pareto_khat(x, ...) The default is \code{"both"}.} \item{r_eff}{(numeric) relative effective sample size estimate. If -\code{r_eff} is omitted, it will be calculated assuming the draws are +\code{r_eff} is NULL, it will be calculated assuming the draws are from MCMC. Default is 1.} \item{ndraws_tail}{(numeric) number of draws for the tail. If diff --git a/man/pareto_smooth.Rd b/man/pareto_smooth.Rd index f2bd5e34..3e5e444d 100644 --- a/man/pareto_smooth.Rd +++ b/man/pareto_smooth.Rd @@ -51,7 +51,7 @@ returned. Default is \code{FALSE}.} The default is \code{"both"}.} \item{r_eff}{(numeric) relative effective sample size estimate. If -\code{r_eff} is omitted, it will be calculated assuming the draws are +\code{r_eff} is NULL, it will be calculated assuming the draws are from MCMC. Default is 1.} \item{ndraws_tail}{(numeric) number of draws for the tail. If