Skip to content

Commit b42fde1

Browse files
committed
fix Rd file
1 parent fb567bd commit b42fde1

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

rstan/rstan/man/stanfit-method-loo.Rd

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ sampling (Vehtari, Gelman, and Gabry, 2017a,2017b).
2020
cores = getOption("mc.cores", 1),
2121
moment_match = FALSE,
2222
k_threshold = 0.7,
23+
r_eff = FALSE,
2324
\dots)
2425
}
2526

@@ -43,14 +44,14 @@ sampling (Vehtari, Gelman, and Gabry, 2017a,2017b).
4344
\item{k_threshold}{Threshold value for Pareto k values above which
4445
the moment matching algorithm is used. If \code{moment_match} is \code{FALSE},
4546
this is ignored.}
46-
\item{r_eff} \code{TRUE} or \code{FALSE} indicating whether to compute the
47+
\item{r_eff}{\code{TRUE} or \code{FALSE} indicating whether to compute the
4748
\code{r_eff} argument to pass to the \pkg{loo} package. If \code{TRUE},
4849
will call \code{loo::relative_eff()}. If \code{FALSE}
4950
(the default), we avoid computing \code{r_eff}, which can be very slow.
5051
\code{r_eff} measures the amount of autocorrelation in MCMC draws, and is
5152
used to compute more accurate ESS and MCSE estimates for pointwise and
5253
total ELPDs. When \code{r_eff=FALSE}, the reported ESS and MCSE estimates
53-
may be over-optimistic if the posterior draws are far from independent.
54+
may be over-optimistic if the posterior draws are far from independent.}
5455
\item{\dots}{Ignored.}
5556
}
5657

0 commit comments

Comments
 (0)