diff --git a/R/pareto_smooth.R b/R/pareto_smooth.R index 976296c..39acaac 100644 --- 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 index 92e0937..488e60b 100644 --- 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 index e84f0b4..31420b9 100644 --- a/man/pareto_diags.Rd +++ b/man/pareto_diags.Rd @@ -68,7 +68,7 @@ The default is \code{"both"}.} \item{r_eff}{(numeric) relative effective sample size estimate. If \code{r_eff} is NULL, it will be calculated assuming the draws are -from MCMC. Default is 1.} +from MCMC. Default is NULL.} \item{ndraws_tail}{(numeric) number of draws for the tail. If \code{ndraws_tail} is not specified, it will be calculated as @@ -134,8 +134,8 @@ pareto_diags(d$Sigma) \references{ Aki Vehtari, Daniel Simpson, Andrew Gelman, Yuling Yao and Jonah Gabry (2024). Pareto Smoothed Importance Sampling. -\emph{Journal of Machine Learning Research}, accepted for publication. -arxiv:arXiv:1507.02646 (version 8) +\emph{Journal of Machine Learning Research}, 25(72):1-58. +\href{https://jmlr.org/papers/v25/19-556.html}{PDF} } \seealso{ \code{\link{pareto_khat}} for only calculating khat, and diff --git a/man/pareto_khat.Rd b/man/pareto_khat.Rd index 120afe8..9df455d 100644 --- a/man/pareto_khat.Rd +++ b/man/pareto_khat.Rd @@ -41,7 +41,7 @@ The default is \code{"both"}.} \item{r_eff}{(numeric) relative effective sample size estimate. If \code{r_eff} is NULL, it will be calculated assuming the draws are -from MCMC. Default is 1.} +from MCMC. Default is NULL.} \item{ndraws_tail}{(numeric) number of draws for the tail. If \code{ndraws_tail} is not specified, it will be calculated as @@ -76,8 +76,8 @@ pareto_khat(d$Sigma) \references{ Aki Vehtari, Daniel Simpson, Andrew Gelman, Yuling Yao and Jonah Gabry (2024). Pareto Smoothed Importance Sampling. -\emph{Journal of Machine Learning Research}, accepted for publication. -arxiv:arXiv:1507.02646 (version 8) +\emph{Journal of Machine Learning Research}, 25(72):1-58. +\href{https://jmlr.org/papers/v25/19-556.html}{PDF} } \seealso{ \code{\link{pareto_diags}} for additional related diagnostics, and diff --git a/man/pareto_smooth.Rd b/man/pareto_smooth.Rd index a293d08..d89b1ab 100644 --- a/man/pareto_smooth.Rd +++ b/man/pareto_smooth.Rd @@ -13,7 +13,7 @@ pareto_smooth(x, ...) \method{pareto_smooth}{default}( x, tail = c("both", "right", "left"), - r_eff = 1, + r_eff = NULL, ndraws_tail = NULL, return_k = FALSE, extra_diags = FALSE, @@ -53,7 +53,7 @@ The default is \code{"both"}.} \item{r_eff}{(numeric) relative effective sample size estimate. If \code{r_eff} is NULL, it will be calculated assuming the draws are -from MCMC. Default is 1.} +from MCMC. Default is NULL.} \item{ndraws_tail}{(numeric) number of draws for the tail. If \code{ndraws_tail} is not specified, it will be calculated as @@ -94,8 +94,8 @@ pareto_smooth(d$Sigma) \references{ Aki Vehtari, Daniel Simpson, Andrew Gelman, Yuling Yao and Jonah Gabry (2024). Pareto Smoothed Importance Sampling. -\emph{Journal of Machine Learning Research}, accepted for publication. -arxiv:arXiv:1507.02646 (version 8) +\emph{Journal of Machine Learning Research}, 25(72):1-58. +\href{https://jmlr.org/papers/v25/19-556.html}{PDF} } \seealso{ \code{\link{pareto_khat}} for only calculating khat, and