-
Notifications
You must be signed in to change notification settings - Fork 9
/
summary.posterior.Rd
41 lines (34 loc) · 1.11 KB
/
summary.posterior.Rd
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
32
33
34
35
36
37
38
39
40
41
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/posteriors.R
\name{summary.posterior}
\alias{summary.posterior}
\title{Summarize the Posterior Distributions of Model Statistics}
\usage{
\method{summary}{posterior}(object, prob = 0.9,
seed = sample.int(10000, 1), ...)
}
\arguments{
\item{object}{An object produced by \code{\link[=tidy.perf_mod]{tidy.perf_mod()}}.}
\item{prob}{A number p (0 < p < 1) indicating the desired
probability mass to include in the intervals.}
\item{seed}{A single integer for sampling from the posterior.}
\item{...}{Not currently used}
}
\value{
A data frame with summary statistics and a row for
each model.
}
\description{
Numerical summaries are created for each model including the
posterior mean and upper and lower credible intervals (aka
uncertainty intervals).
}
\examples{
# Example objects from the "Getting Started" vignette at
# https://topepo.github.io/tidyposterior/articles/Getting_Started.html
# File for pre-run model is at
ex_dat <- "https://bit.ly/2OJdvl1"
# load(load(url(ex_dat))
# posterior_values <- tidy(roc_model)
# summary(posterior_values)
}