docs: more clarity on refresh_steps parameter #507

facebookexperimental · Oct 5, 2022 · 0e48287 · 0e48287
1 parent 81628de
commit 0e48287
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/R/R/refresh.R b/R/R/refresh.R
@@ -42,8 +42,10 @@
 #' Prophet holidays using \code{data("dt_prophet_holidays")}.
 #' @param refresh_steps Integer. It controls how many time units the refresh
 #' model build move forward. For example, \code{refresh_steps = 4} on weekly data
-#' means the InputCollect$window_start & InputCollect$window_end move forward
-#' 4 weeks.
+#' means the \code{InputCollect$window_start} & \code{InputCollect$window_end}
+#' move forward 4 weeks. If \code{refresh_steps} is smaller than the number of
+#' newly provided data points, then Robyn would only use the first N steps of the
+#' new data.
 #' @param refresh_mode Character. Options are "auto" and "manual". In auto mode,
 #' the \code{robyn_refresh()} function builds refresh models with given
 #' \code{refresh_steps} repeatedly until there's no more data available. I

diff --git a/R/man/robyn_refresh.Rd b/R/man/robyn_refresh.Rd