diff --git a/R/Prior.R b/R/Prior.R index b32f61f3..a978a054 100755 --- a/R/Prior.R +++ b/R/Prior.R @@ -8,6 +8,7 @@ NULL #' constructors. #' #' @param centre (`number`)\cr the central point of distribution to shrink sampled values towards +#' (for most distributions this is the mean or median if the mean is undefined) #' @param x ([`Prior`])\cr a prior Distribution #' @param object ([`Prior`])\cr a prior Distribution #' @param name (`character`)\cr the name of the parameter the prior distribution is for @@ -58,7 +59,7 @@ NULL #' @param validation (`list`)\cr the prior distribution parameter validation functions. Must have #' the same names as the `paramaters` slot. #' @param sample (`function`)\cr a function to sample from the prior distribution. -#' @param limits (`numeric`)\cr TODO +#' @param limits (`numeric`)\cr the lower and upper limits for a truncated distribution #' @rdname Prior-class Prior <- function( parameters, diff --git a/man/Prior-Shared.Rd b/man/Prior-Shared.Rd index 218ae8e8..6f4cb023 100644 --- a/man/Prior-Shared.Rd +++ b/man/Prior-Shared.Rd @@ -4,7 +4,8 @@ \alias{Prior-Shared} \title{\code{Prior} Function Arguments} \arguments{ -\item{centre}{(\code{number})\cr the central point of distribution to shrink sampled values towards} +\item{centre}{(\code{number})\cr the central point of distribution to shrink sampled values towards +(for most distributions this is the mean or median if the mean is undefined)} \item{x}{(\code{\link{Prior}})\cr a prior Distribution} diff --git a/man/Prior-class.Rd b/man/Prior-class.Rd index f06151b6..f666c2d6 100644 --- a/man/Prior-class.Rd +++ b/man/Prior-class.Rd @@ -34,7 +34,7 @@ the same names as the \code{paramaters} slot.} \item{sample}{(\code{function})\cr a function to sample from the prior distribution.} -\item{limits}{(\code{numeric})\cr TODO} +\item{limits}{(\code{numeric})\cr the lower and upper limits for a truncated distribution} } \description{ Specifies the prior distribution in a Stan Model