Skip to content

Commit d2459bc

Browse files
committed
docs(epi_slide): have function intro sentence in intro paragraph
1 parent a79361a commit d2459bc

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

R/slide.R

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
#' More general form of [`epi_slide_opt`] for rolling/running computations
22
#'
33
#' Most rolling/running computations can be handled by [`epi_slide_mean`],
4-
#' [`epi_slide_sum`], or the medium-generality [`epi_slide_opt`] functions
5-
#' instead, which are much faster. You typically only need to consider
6-
#' `epi_slide()` if you have a computation that depends on multiple columns
7-
#' simultaneously, outputs multiple columns simultaneously, or produces
8-
#' non-numeric output. For example, this computation depends on multiple
9-
#' columns:
4+
#' [`epi_slide_sum`], or the medium-generality [`epi_slide_opt`] functions,
5+
#' which have been specialized to run more quickly. `epi_slide()` is a slower
6+
#' but even more general function for rolling/running computations, and uses a
7+
#' different interface to specify the computations; you typically only need to
8+
#' consider using `epi_slide()` if you have a computation that depends on
9+
#' multiple columns simultaneously, outputs multiple columns simultaneously, or
10+
#' produces non-numeric output. For example, this computation depends on
11+
#' multiple columns:
1012
#'
1113
#' ```
1214
#' cases_deaths_subset %>%

man/epi_slide.Rd

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

0 commit comments

Comments
 (0)