Add input validation to estimators

[Rnaught] / R / idea.R

diff --git a/R/idea.R b/R/idea.R
index 054952729ac9d35026203581905d3d9b681fc9f7..dad42207677334f59ec265b061c2c379bef5bd8e 100644 (file)
--- a/R/idea.R
+++ b/R/idea.R
@@ -25,9 +25,8 @@
 #'
 #' @return An estimate of the basic reproduction number (R0).
 #'
-#' @references
-#' [Fisman et al. (PloS One, 2013)](
-#' https://doi.org/10.1371/journal.pone.0083622)
+#' @references [Fisman et al. (PloS One, 2013)](
+#'   https://doi.org/10.1371/journal.pone.0083622)
 #'
 #' @seealso [id()] for a similar method.
 #'
@@ -43,6 +42,13 @@
 #' # Obtain R0 when the serial distribution has a mean of three days.
 #' idea(cases, mu = 3 / 7)
 idea <- function(cases, mu) {
+  validate_cases(cases, min_length = 2, min_count = 1)
+  if (!is_real(mu) || mu <= 0) {
+    stop("The serial interval (`mu`) must be a number greater than 0.",
+      call. = FALSE
+    )
+  }
+
   s <- seq_along(cases) / mu
 
   x1 <- sum(s)