update trunc_opts docs

epiforecasts · sbfnk · Nov 18, 2022 · Jul 21, 2022 · Jul 21, 2022 · Jul 25, 2022
commit 2c51993839c26f69accfa6724e49fc9f6a1cd910
diff --git a/R/opts.R b/R/opts.R
@@ -163,13 +163,18 @@ delay_opts <- function(..., fixed = FALSE) {
 #'  downstream functions. See `estimate_truncation()` for an approach to
 #'  estimate this distribution.
 #' @param mean Numeric, defaults to 0. Mean on the log scale of the truncation
-#' distribution
+#' distribution.
+#'
 #' @param sd Numeric, defaults to 0. Sets the standard deviation for the log
-#' normal truncation distribution
+#' normal truncation distribution.
+#'
 #' @param mean_sd Numeric, defaults to 0. The prior uncertainty for the log
 #' normal truncation distribution.
+#'
 #' @param sd_sd Numeric, defaults to 0. The prior uncertainty for the standard
 #' deviation of the  log normal truncation distribution.
+#'
+#' @param max Numeric, maximum value to allow. Defaults to 0.
 #' @seealso convert_to_logmean convert_to_logsd bootstrapped_dist_fit
 #' @return A list summarising the input truncation distribution.
 #' @export