feat: new date_min and date_max checks for robyn_allocator #366

R/R/allocator.R

@@ -49,7 +49,7 @@
 #' @param constr_mode Character. Options are \code{"eq"} or \code{"ineq"},
 #' indicating constraints with equality or inequality.
 #' @param date_min,date_max Character. Date range to calculate mean (of non-zero spends) and
-#' total spends. Default will consider all dates within window.
+#' total spends. Default will consider all dates within window. Length must be 1.
 #' @return A list object containing allocator result.
 #' @examples
 #' \dontrun{
@@ -186,6 +186,7 @@ robyn_allocator <- function(robyn_object = NULL,
 
   # Spend values based on date range set
   dt_optimCost <- dt_mod %>% slice(startRW:endRW)
+  check_daterange(date_min, date_max, dt_optimCost$ds)
   if (is.null(date_min)) date_min <- min(dt_optimCost$ds)
   if (is.null(date_max)) date_max <- max(dt_optimCost$ds)
   if (date_min < min(dt_optimCost$ds)) date_min <- min(dt_optimCost$ds)

R/R/checks.R

@@ -684,3 +684,16 @@ check_run_inputs <- function(cores, iterations, trials, intercept_sign, nevergra
     stop(sprintf("Input 'intercept_sign' must be any of: %s", paste(opts, collapse = ", ")))
   }
 }
+
+check_daterange <- function(date_min, date_max, dates) {
+  if (!is.null(date_min)) {
+    if (length(date_min) > 1) stop("Set a single date for 'date_min' parameter")
+    if (date_min < min(dates)) warning(sprintf(
+      "Parameter 'date_min' not in your data's date range. Changed to '%s'", min(dates)))
+  }
+  if (!is.null(date_max)) {
+    if (length(date_max) > 1) stop("Set a single date for 'date_max' parameter")
+    if (date_max > max(dates)) warning(sprintf(
+      "Parameter 'date_max' not in your data's date range. Changed to '%s'", max(dates)))
+  }
+}