change default for r_eff to 1 in pareto_smooth (and others)

stan-dev · Nov 15, 2023 · da23af6 · da23af6
1 parent 64e7558
commit da23af6
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 6 deletions.
diff --git a/R/pareto_smooth.R b/R/pareto_smooth.R
@@ -251,7 +251,7 @@ pareto_smooth.rvar <- function(x, return_k = TRUE, extra_diags = FALSE, ...) {
 #' @export
 pareto_smooth.default <- function(x,
                                   tail = c("both", "right", "left"),
-                                  r_eff = NULL,
+                                  r_eff = 1,
                                   ndraws_tail = NULL,
                                   return_k = TRUE,
                                   extra_diags = FALSE,

diff --git a/man-roxygen/args-pareto.R b/man-roxygen/args-pareto.R
@@ -15,7 +15,7 @@
 #'   al. (2022)).
 #' @param r_eff (numeric) relative effective sample size estimate. If
 #'   `r_eff` is omitted, it will be calculated assuming the draws are
-#'   from MCMC.
+#'   from MCMC. Default is 1.
 #' @param verbose (logical) Should diagnostic messages be printed? If
 #'   `TRUE`, messages related to Pareto diagnostics will be
 #'   printed. Default is `FALSE`.

diff --git a/man/pareto_diags.Rd b/man/pareto_diags.Rd
diff --git a/man/pareto_khat.Rd b/man/pareto_khat.Rd
diff --git a/man/pareto_smooth.Rd b/man/pareto_smooth.Rd