warn of behaviour change

epiforecasts · Oct 6, 2023 · 27c1140 · 27c1140
1 parent 1804556
commit 27c1140
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/R/dist.R b/R/dist.R
@@ -905,6 +905,14 @@ tune_inv_gamma <- function(lower = 2, upper = 21) {
 dist_spec <- function(mean, sd = 0, mean_sd = 0, sd_sd = 0,
                       distribution = c("lognormal", "gamma"), max,
                       pmf = numeric(0), fixed = FALSE) {
+  ## deprecate previous behaviour
+  warning(
+    "The meaning of the 'max' argument has changed compared to ",
+    "previous versions. It now indicates the maximum of a distribution ",
+    "rather than the length of the probability mass function (including 0) ",
+    "that it represented previously. To replicate previous behaviour reduce ",
+    "max by 1".
+  )
   ## check if parametric or nonparametric
   if (length(pmf) > 0 &&
     !all(