Merge pull request #167 from dajmcdon/km-slide-n-fix

Remove default `n` values in `epi_slide` and `epix_slide`

Author: brookslogan

DESCRIPTION

@@ -56,7 +56,7 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.0
+RoxygenNote: 7.2.1
 Depends: 
     R (>= 2.10)
 URL: https://cmu-delphi.github.io/epiprocess/

R/archive.R

@@ -292,7 +292,7 @@ epi_archive =
 #'   details. 
 #' @importFrom data.table key
 #' @importFrom rlang !! !!! enquo enquos is_quosure sym syms
-          slide = function(f, ..., n = 7, group_by, ref_time_values, 
+          slide = function(f, ..., n, group_by, ref_time_values, 
                            time_step, new_col_name = "slide_value",
                            as_list_col = FALSE, names_sep = "_",
                            all_rows = FALSE) { 

R/methods-epi_archive.R

@@ -115,7 +115,7 @@ epix_merge = function(x, y, ..., locf = TRUE, nan = NA) {
 #' @param n Number of time steps to use in the running window. For example, if
 #'   `n = 7`, and one time step is one day, then to produce a value on January 7
 #'   we apply the given function or formula to data in between January 1 and
-#'   7. Default is 7.
+#'   7.
 #' @param group_by The variable(s) to group by before slide computation. If
 #'   missing, then the keys in the underlying data table, excluding `time_value`
 #'   and `version`, will be used for grouping. To omit a grouping entirely, use
@@ -202,7 +202,7 @@ epix_merge = function(x, y, ..., locf = TRUE, nan = NA) {
 #'            group_by = geo_value,
 #'            ref_time_values = time_values,
 #'            new_col_name = 'case_rate_3d_av')
-epix_slide = function(x, f, ..., n = 7, group_by, ref_time_values,
+epix_slide = function(x, f, ..., n, group_by, ref_time_values,
                       time_step, new_col_name = "slide_value",
                       as_list_col = FALSE, names_sep = "_", all_rows = FALSE) {
   if (!inherits(x, "epi_archive")) Abort("`x` must be of class `epi_archive`.")

R/slide.R

@@ -22,7 +22,7 @@
 #' @param n Number of time steps to use in the running window. For example, if
 #'   `n = 7`, one time step is one day, and the alignment is "right", then to
 #'   produce a value on January 7 we apply the given function or formula to data
-#'   in between January 1 and 7. Default is 7.
+#'   in between January 1 and 7.
 #' @param ref_time_values Time values for sliding computations, meaning, each
 #'   element of this vector serves as the reference time point for one sliding
 #'   window. If missing, then this will be set to all unique time values in the
@@ -114,7 +114,7 @@
 #'  epi_slide(a = data.frame(cases_2dav = mean(cases), 
 #'                           cases_2dma = mad(cases)),
 #'            n = 2, as_list_col = TRUE)
-epi_slide = function(x, f, ..., n = 7, ref_time_values,
+epi_slide = function(x, f, ..., n, ref_time_values,
                      align = c("right", "center", "left"), before, time_step, 
                      new_col_name = "slide_value", as_list_col = FALSE,
                      names_sep = "_", all_rows = FALSE) {