Skip to content

Commit

Permalink
args-priors.R: mention product_normal prior
Browse files Browse the repository at this point in the history
  • Loading branch information
bgoodri committed Jan 8, 2017
1 parent bac50ad commit 7b2885c
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions man-roxygen/args-priors.R
@@ -1,14 +1,15 @@
#' @param prior The prior distribution for the regression coefficients.
#' \code{prior} should be a call to one of the various functions provided by
#' \pkg{rstanarm} for specifying priors. The subset of these functions that
#' can be used for the prior on the coefficients can be grouped into three
#' can be used for the prior on the coefficients can be grouped into several
#' "families":
#'
#' \tabular{ll}{
#' \strong{Family} \tab \strong{Functions} \cr
#' \emph{Student t family} \tab \code{normal}, \code{student_t}, \code{cauchy} \cr
#' \emph{Hierarchical shrinkage family} \tab \code{hs}, \code{hs_plus} \cr
#' \emph{Laplace family} \tab \code{laplace}, \code{lasso} \cr
#' \emph{Product normal family} \tab \code{product_normal} \cr
#' }
#'
#' See the \link[=priors]{priors help page} for details on the families and
Expand All @@ -21,7 +22,7 @@
#' family or Laplace family, and if the \code{autoscale} argument to the
#' function used to specify the prior (e.g. \code{\link{normal}}) is left at
#' its default and recommended value of \code{TRUE}, then the default or
#' user-specified prior scale(s) may be tuned internally based on the scales
#' user-specified prior scale(s) may be adjusted internally based on the scales
#' of the predictors. See the \link[=priors]{priors help page} for details on
#' the rescaling and the \code{\link{prior_summary}} function for a summary of
#' the priors used for a particular model.
Expand Down

0 comments on commit 7b2885c

Please sign in to comment.