Skip to content

Commit 4f90dda

Browse files
committed
docs: fix epi_slide() column packing note
1 parent f23c5c9 commit 4f90dda

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

R/slide.R

+5-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,11 @@
1919
#' @template basic-slide-params
2020
#' @param .f Function, formula, or missing; together with `...` specifies the
2121
#' computation to slide. The return of the computation should either be a
22-
#' scalar or a 1-row data frame. Data frame returns will be
23-
#' `tidyr::unpack()`-ed, if named, and will be [`tidyr::pack`]-ed columns, if
24-
#' not named. See examples.
22+
#' scalar or a 1-row data frame; these outputs will be collected and form a
23+
#' new column or columns in the `epi_slide()` result. Data frame returns will
24+
#' be unpacked into multiple columns in the result by default, or
25+
#' [`tidyr::pack`]ed into a single data-frame-type column if you provide a
26+
#' name for such a column. See examples.
2527
#'
2628
#' - If `.f` is missing, then `...` will specify the computation via
2729
#' tidy-evaluation. This is usually the most convenient way to use

man/epi_slide.Rd

+5-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)