https://github.com/cran/bayestestR
Raw File
Tip revision: 40f7c88ddf855896018cf20ec8a7ac5fbd0ea2fb authored by Dominique Makowski on 27 January 2020, 05:30 UTC
version 0.5.1
Tip revision: 40f7c88
describe_prior.Rd
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/describe_prior.R
\name{describe_prior}
\alias{describe_prior}
\title{Describe Priors}
\usage{
describe_prior(model, ...)
}
\arguments{
\item{model}{A Bayesian model.}

\item{...}{Currently not used.}
}
\description{
Returns a summary of the priors used in the model.
}
\examples{
\dontrun{
library(bayestestR)

# rstanarm models
# -----------------------------------------------
library(rstanarm)
model <- rstanarm::stan_glm(mpg ~ wt + cyl, data = mtcars)
describe_prior(model)

# brms models
# -----------------------------------------------
library(brms)
model <- brms::brm(mpg ~ wt + cyl, data = mtcars)
describe_prior(model)

# BayesFactor objects
# -----------------------------------------------
library(BayesFactor)
bf <- ttestBF(x = rnorm(100, 1, 1))
describe_prior(bf)
}

}
back to top