% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/priors.R
\name{prior_cauchy}
\alias{prior_cauchy}
\title{Specify a Cauchy prior}
\usage{
prior_cauchy(mean = 0, sd = 2.5, autoscale = FALSE)
}
\arguments{
\item{mean}{Prior location (default 0).}

\item{sd}{Prior scale (default 2.5).}

\item{autoscale}{See \code{\link[=prior_normal]{prior_normal()}}. Default \code{FALSE}.}
}
\value{
A list with components \code{distribution = "student_t"}, \code{df = 1},
\code{mean}, \code{sd}, \code{autoscale}.
}
\description{
Cauchy is Student-t with \code{df = 1}; this constructor is a convenience
wrapper around \code{\link[=prior_student_t]{prior_student_t()}}. It has very heavy tails and should
be used with care — modern recommendations generally prefer
\verb{prior_student_t(df in 3:7, ...)} over Cauchy for regression
coefficients to keep sampling well-behaved (see Piironen & Vehtari on
the horseshoe; Ghosh et al. 2015).
}
\examples{
prior_cauchy(mean = 0, sd = 2.5)
}
