Skip to content

Commit d369527

Browse files
committed
docs: roughly describe grouping of epix_slide output
1 parent 5c68195 commit d369527

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

R/methods-epi_archive.R

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -688,10 +688,10 @@ epix_detailed_restricted_mutate <- function(.data, ...) {
688688
#' requested `.versions`) for rows having a `time_value` of at least `.version
689689
#' - before`. Otherwise, the slide computation will be passed only the most
690690
#' recent `version` for every unique `time_value`. Default is `FALSE`.
691-
#' @return A tibble whose columns are: the grouping variables, `time_value`,
692-
#' containing the reference time values for the slide computation, and a
693-
#' column named according to the `.new_col_name` argument, containing the slide
694-
#' values.
691+
#' @return A tibble whose columns are: the grouping variables (if any),
692+
#' `time_value`, containing the reference time values for the slide
693+
#' computation, and a column named according to the `.new_col_name` argument,
694+
#' containing the slide values. It will be grouped by the grouping variables.
695695
#'
696696
#' @details A few key distinctions between the current function and `epi_slide()`:
697697
#' 1. In `.f` functions for `epix_slide`, one should not assume that the input

man/epix_slide.Rd

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)