Skip to content

Commit 9ab94d7

Browse files
authored
Update documentation for E_loo() function
Clarify the conditions for reliable estimates in E_loo()
1 parent d6fe380 commit 9ab94d7

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

R/E_loo.R

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55
#' [PSIS][psis()] smoothing procedure. The expectations estimated by the
66
#' `E_loo()` function assume that the PSIS approximation is working well.
77
#' **A small [Pareto k][pareto-k-diagnostic] estimate is necessary,
8-
#' but not sufficient, for `E_loo()` to give reliable estimates.** Additional
9-
#' diagnostic checks for gauging the reliability of the estimates are in
10-
#' development and will be added in a future release.
8+
#' but not sufficient, for `E_loo()` to give reliable estimates. If
9+
#' If `log_ratios` argument is provided, `E_loo()` computes also a function
10+
#' specific Pareto k, which needs also to be small for a reliable estimate.
11+
# See more below.
1112
#'
1213
#' @export
1314
#' @param x A numeric vector or matrix.

0 commit comments

Comments
 (0)