Skip to content

Commit 531f4dd

Browse files
committed
more doc cleaning
1 parent 6b2889e commit 531f4dd

4 files changed

Lines changed: 6 additions & 18 deletions

File tree

R/extract_log_lik.R

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
#' Extract pointwise log-likelihood from a Stan model
22
#'
33
#' Convenience function for extracting the pointwise log-likelihood
4-
#' matrix or array from a fitted Stan model.
4+
#' matrix or array from a `stanfit` object from the \pkg{rstan} package.
5+
#' Note: recent versions of \pkg{rstan} now include a `loo()` method for
6+
#' `stanfit` objects that handles this internally.
57
#'
68
#' @export
79
#' @param stanfit A `stanfit` object (\pkg{rstan} package).

R/loo.R

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,14 +109,6 @@
109109
#' loo(LLmat, r_eff = rel_n_eff, cores = 2)
110110
#'
111111
#'
112-
#' \dontrun{
113-
#' ### Usage with stanfit objects
114-
#' # see ?extract_log_lik
115-
#' log_lik1 <- extract_log_lik(stanfit1, merge_chains = FALSE)
116-
#' rel_n_eff <- relative_eff(exp(log_lik1))
117-
#' loo(log_lik1, r_eff = rel_n_eff, cores = 2)
118-
#' }
119-
#'
120112
#' ### Using log-likelihood function instead of array or matrix
121113
#' set.seed(124)
122114
#'

man/extract_log_lik.Rd

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/loo.Rd

Lines changed: 0 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)