Merge pull request #508 from cmu-delphi/ndefries/remove-name-col-doc

Mark `new_col_name` and `names_sep` as not used for optimized slide fns

Author: dshemetov

R/slide.R

@@ -408,13 +408,19 @@ epi_slide_opt <- function(x, col_names, f, ..., before = NULL, after = NULL, ref
   }
   if (!is.null(new_col_name)) {
     cli_abort(
-      "`new_col_name` is not supported for `epi_slide_[opt/mean/sum]`",
+      c(
+        "`new_col_name` is not supported for `epi_slide_[opt/mean/sum]`",
+        "i" = "If you want to customize the output column names, use [`dplyr::rename`] after the slide."
+      ),
       class = "epiprocess__epi_slide_opt__new_name_not_supported"
     )
   }
   if (!is.null(names_sep)) {
     cli_abort(
-      "`names_sep` is not supported for `epi_slide_[opt/mean/sum]`",
+      c(
+        "`names_sep` is not supported for `epi_slide_[opt/mean/sum]`",
+        "i" = "If you want to customize the output column names, use [`dplyr::rename`] after the slide."
+      ),
       class = "epiprocess__epi_slide_opt__name_sep_not_supported"
     )
   }

man-roxygen/opt-slide-params.R

@@ -9,8 +9,5 @@
 #'   to provide output column names; if you want to customize the output column
 #'   names, use [`dplyr::rename`] after the slide.
 #' @param as_list_col Not supported. Included to match `epi_slide` interface.
-#' @param new_col_name Character vector indicating the name(s) of the new
-#'  column(s) that will contain the derivative values. Default
-#'  is "slide_value"; note that setting `new_col_name` equal to any existing
-#'  column names will overwrite those columns. If `names_sep` is `NULL`,
-#'  `new_col_name` must be the same length as `col_names`.
+#' @param new_col_name Not supported. Included to match `epi_slide` interface.
+#' @param names_sep Not supported. Included to match `epi_slide` interface.