File: weights.importance_sampling.Rd

package info (click to toggle)
r-cran-loo 2.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,836 kB
  • sloc: sh: 15; makefile: 2
file content (31 lines) | stat: -rw-r--r-- 1,016 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/importance_sampling.R
\name{weights.importance_sampling}
\alias{weights.importance_sampling}
\title{Extract importance sampling weights}
\usage{
\method{weights}{importance_sampling}(object, ..., log = TRUE, normalize = TRUE)
}
\arguments{
\item{object}{An object returned by \code{\link[=psis]{psis()}}, \code{\link[=tis]{tis()}}, or \code{\link[=sis]{sis()}}.}

\item{...}{Ignored.}

\item{log}{Should the weights be returned on the log scale? Defaults to
\code{TRUE}.}

\item{normalize}{Should the weights be normalized? Defaults to \code{TRUE}.}
}
\value{
The \code{weights()} method returns an object with the same dimensions as
the \code{log_weights} component of \code{object}. The \code{normalize} and \code{log}
arguments control whether the returned weights are normalized and whether
or not to return them on the log scale.
}
\description{
Extract importance sampling weights
}
\examples{
# See the examples at help("psis")

}