Skip to content

Commit a317594

Browse files
committed
make wrapper language clearer; add dots to ref_time_value
1 parent 93e965f commit a317594

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

R/utils.R

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -202,9 +202,9 @@ assert_sufficient_f_args <- function(f, ...) {
202202
#'
203203
#' If a **function** and `calc_ref_time_value` is `FALSE`, the function is
204204
#' returned as-is, with no modifications. If `calc_ref_time_value` is
205-
#' `TRUE`, a wrapper function is returned. The wrapper calculates
206-
#' `ref_time_value` based on the input data and passes it to the original
207-
#' function.
205+
#' `TRUE`, a function wrapping the original function is returned. The
206+
#' wrapper calculates `.ref_time_value` based on the input data and passes
207+
#' it to the original function.
208208
#'
209209
#' If a **formula**, e.g. `~ mean(.x$cases)`, it is converted to a function
210210
#' with up to three arguments: `.x` (single argument), or `.x` and `.y`
@@ -218,10 +218,10 @@ assert_sufficient_f_args <- function(f, ...) {
218218
#' If a **quosure**, in the case that `f` was not provided to the parent
219219
#' `epi[x]_slide` call and the `...` is interpreted as an expression for
220220
#' tidy evaluation, it is evaluated within a wrapper function. The wrapper
221-
#' sets up object access via a data mask. `ref_time_value` is calculated
221+
#' sets up object access via a data mask. `.ref_time_value` is calculated
222222
#' depending on the `cal_ref_time_value` setting.
223223
#'
224-
#' @param before how far `before` each `ref_time_value` the sliding window
224+
#' @param before How far `before` each `ref_time_value` the sliding window
225225
#' should extend, as specified in the parent `epi[x]_slide` call. Must be a
226226
#' single, non-`NA`, non-negative,[integer-compatible]
227227
#' [vctrs::vec_cast] number of time steps. Used only when

0 commit comments

Comments
 (0)