Skip to content

Commit 4a3eafc

Browse files
committed
docs(epi_slide): use "subpopulation" to help clarify grouping
1 parent 618f841 commit 4a3eafc

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

R/slide.R

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@
1919
#'
2020
#' @template basic-slide-params
2121
#' @param .f,... The computation to slide. The input will be a time window of
22-
#' the data for a single `geo_value` --- or a single combination of
23-
#' `geo_value` and any [`other_keys`][as_epi_df] you used to specify
24-
#' demographical breakdowns. The input will always have the same size,
25-
#' determined by `.window_size`, and will fill in any missing `time_values`,
26-
#' using `NA` values for missing measurements. The output should be a scalar
27-
#' value or a 1-row data frame; these outputs will be collected and form a new
28-
#' column or columns in the `epi_slide()` result. Data frame outputs will be
29-
#' unpacked into multiple columns in the result by default, or
30-
#' [`tidyr::pack`]ed into a single data-frame-type column if you provide a
31-
#' name for such a column (e.g., via `.new_col_name`).
22+
#' the data for a single subpopulation (i.e., a single `geo_value` and single
23+
#' value for any [`other_keys`][as_epi_df] you set up for age groups, etc.).
24+
#' The input will always have the same size, determined by `.window_size`, and
25+
#' will fill in any missing `time_values`, using `NA` values for missing
26+
#' measurements. The output should be a scalar value or a 1-row data frame;
27+
#' these outputs will be collected and form a new column or columns in the
28+
#' `epi_slide()` result. Data frame outputs will be unpacked into multiple
29+
#' columns in the result by default, or [`tidyr::pack`]ed into a single
30+
#' data-frame-type column if you provide a name for such a column (e.g., via
31+
#' `.new_col_name`).
3232
#'
3333
#' You can specify the computation in one of the following ways:
3434
#'

man/epi_slide.Rd

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

0 commit comments

Comments
 (0)