updated docs

Genentech · Jul 1, 2024 · a9c9f1a · a9c9f1a
1 parent 709161b
commit a9c9f1a
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git 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
diff --git a/man/Prior-class.Rd b/man/Prior-class.Rd