Add input validation to estimators

[Rnaught] / R / seq_bayes.R

diff --git a/R/seq_bayes.R b/R/seq_bayes.R
index d486d2b8e439e34436fb3919345a56c79066f543..ccc9a415195b808da8995c7b39043c01a18e2269 100644 (file)
--- a/R/seq_bayes.R
+++ b/R/seq_bayes.R
@@ -84,10 +84,31 @@
 #' # Note that the following always holds:
 #' estimate == sum(posterior$supp * posterior$pmf)
 seq_bayes <- function(cases, mu, kappa = 20, post = FALSE) {
 #' # Note that the following always holds:
 #' estimate == sum(posterior$supp * posterior$pmf)
 seq_bayes <- function(cases, mu, kappa = 20, post = FALSE) {

+  validate_cases(cases, min_length = 2, min_count = 0)
+  if (!is_real(mu) || mu <= 0) {
+    stop("The serial interval (`mu`) must be a number greater than 0.",
+      call. = FALSE
+    )
+  }
+  if (!is_real(kappa) || kappa < 1) {
+    stop(
+      paste("The largest value of the uniform prior (`kappa`)",
+        "must be a number greater than or equal to 1."
+      ), call. = FALSE
+    )
+  }
+  if (!identical(post, TRUE) && !identical(post, FALSE)) {
+    stop("The posterior flag (`post`) must be set to `TRUE` or `FALSE`.",
+      call. = FALSE
+    )
+  }
+

   if (any(cases == 0)) {
     times <- which(cases > 0)
     if (length(times) < 2) {
   if (any(cases == 0)) {
     times <- which(cases > 0)
     if (length(times) < 2) {

-      stop("Vector of case counts must contain at least two positive integers.")
+      stop("Case counts must contain at least two positive integers.",
+        call. = FALSE
+      )

     }
     cases <- cases[times]
   } else {
     }
     cases <- cases[times]
   } else {