Merge pull request #369 from n-kall/master

`r_eff` default to `NULL`
stan-dev · May 14, 2024 · 419a1a3 · 419a1a3
2 parents c89ed34 + 6c121b8
commit 419a1a3
Show file tree

Hide file tree

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

diff --git a/man-roxygen/args-pareto.R b/man-roxygen/args-pareto.R
@@ -15,7 +15,7 @@
 #'   al. (2024)).
 #' @param r_eff (numeric) relative effective sample size estimate. If
 #'   `r_eff` is NULL, it will be calculated assuming the draws are
-#'   from MCMC. Default is 1.
+#'   from MCMC. Default is NULL.
 #' @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