File: get_priors.Rd

package info (click to toggle)
r-cran-insight 0.19.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,308 kB
  • sloc: sh: 13; makefile: 2
file content (34 lines) | stat: -rw-r--r-- 783 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/get_priors.R
\name{get_priors}
\alias{get_priors}
\alias{get_priors.brmsfit}
\title{Get summary of priors used for a model}
\usage{
get_priors(x, ...)

\method{get_priors}{brmsfit}(x, verbose = TRUE, ...)
}
\arguments{
\item{x}{A Bayesian model.}

\item{...}{Currently not used.}

\item{verbose}{Toggle warnings and messages.}
}
\value{
A data frame with a summary of the prior distributions used
for the parameters in a given model.
}
\description{
Provides a summary of the prior distributions used
for the parameters in a given model.
}
\examples{
\dontrun{
library(rstanarm)
model <- stan_glm(Sepal.Width ~ Species * Petal.Length, data = iris)
get_priors(model)
}

}