wording

Author: nmdefries

R/methods-epi_archive.R

@@ -640,7 +640,7 @@ epix_detailed_restricted_mutate <- function(.data, ...) {
 #'   computation. The computation will be run on each requested group-version
 #'   combination, with a time window filter applied if `.before` is supplied.
 #'
-#'   - If `.f` is a function must have the form `function(x, g, v)` or
+#'   If `.f` is a function must have the form `function(x, g, v)` or
 #'     `function(x, g, v, <additional configuration args>)`, where
 #'
 #'     - `x` is an `epi_df` with the same column names as the archive's `DT`,
@@ -685,7 +685,7 @@ epix_detailed_restricted_mutate <- function(.data, ...) {
 #'   to reporting latency. Unlike `epi_slide()`, `epix_slide()` won't fill in
 #'   any missing `time_values` in this window.
 #' @param .versions Requested versions on which to run the computation. Each
-#'   requested `.version` also serves as the anchor point around which for which
+#'   requested `.version` also serves as the anchor point from which
 #'   the `time_value` window specified by `.before` is drawn. If `.versions` is
 #'   missing, it will be set to a regularly-spaced sequence of values set to
 #'   cover the range of `version`s in the `DT` plus the `versions_end`; the

R/slide.R

@@ -28,11 +28,11 @@
 #' @template basic-slide-params
 #' @param .f,... The computation to slide. The input will be a time window of
 #'   the data for a single subpopulation (i.e., a single `geo_value` and single
-#'   value for any [`other_keys`][as_epi_df] you set up for age groups, etc.).
+#'   value for any [`other_keys`][as_epi_df] you set up, such as age groups, race, etc.).
 #'   The input will always have the same size, determined by `.window_size`, and
 #'   will fill in any missing `time_values`, using `NA` values for missing
 #'   measurements. The output should be a scalar value or a 1-row data frame;
-#'   these outputs will be collected and form a new column or columns in the
+#'   these outputs will be collected into a new column or columns in the
 #'   `epi_slide()` result. Data frame outputs will be unpacked into multiple
 #'   columns in the result by default, or [`tidyr::pack`]ed into a single
 #'   data-frame-type column if you provide a name for such a column (e.g., via
@@ -624,11 +624,11 @@ get_before_after_from_window <- function(window_size, align, time_type) {
 #'   `.window_size = Inf`) on the requested columns. Explicit `NA` measurements
 #'   are temporarily added to fill in any time gaps, and, for rolling
 #'   computations, to pad the time series to ensure that the first & last
-#'   computations are over exactly `.window_size` values.
+#'   computations use exactly `.window_size` values.
 #'
 #' `epi_slide_opt` allows you to use any [data.table::froll] or
-#' [slider::summary-slide] function. If none of the specialized functions here
-#' work, you can use `data.table::frollapply` together with a non-rolling
+#' [slider::summary-slide] function. If none of those specialized functions fit
+#' your usecase, you can use `data.table::frollapply` together with a non-rolling
 #' function (e.g., `median`). See [`epi_slide`] if you need to work with
 #' multiple columns at once or output a custom type.
 #'