From 6854c07cf3e4a1afb465c919b9508e937a081357 Mon Sep 17 00:00:00 2001 From: brookslogan Date: Wed, 4 Sep 2024 06:44:38 +0000 Subject: [PATCH] docs: document (GHA) --- man/epi_slide.Rd | 3 ++- man/epix_slide.Rd | 13 +++++++------ 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/man/epi_slide.Rd b/man/epi_slide.Rd index 950c19e3..b9fa5be6 100644 --- a/man/epi_slide.Rd +++ b/man/epi_slide.Rd @@ -73,7 +73,8 @@ underlying data table, by default.} contain the derivative values. The default is "slide_value" unless your slide computations output data frames, in which case they will be unpacked into the constituent columns and those names used. Note that setting -\code{new_col_name} equal to an existing column name will overwrite this column.} +\code{.new_col_name} equal to an existing column name will overwrite this +column.} \item{.all_rows}{If \code{.all_rows = TRUE}, then all rows of \code{.x} will be kept in the output even with \code{.ref_time_values} provided, with some type of missing diff --git a/man/epix_slide.Rd b/man/epix_slide.Rd index e71c775d..4cfaca6b 100644 --- a/man/epix_slide.Rd +++ b/man/epix_slide.Rd @@ -83,12 +83,13 @@ used for labeling the computations, which are \code{group_vars(x)} and \code{"version"}, then the values for these columns must be identical to the labels we assign.} -\item{.all_versions}{(Not the same as \code{.all_rows} parameter of \code{epi_slide}.) If -\code{.all_versions = TRUE}, then \code{.f} will be passed the version history (all -\code{version <= .ref_time_value}) for rows having \code{time_value} of at least -\code{.version - before}. Otherwise, \code{.f} will be -passed only the most recent \code{version} for every unique \code{time_value}. -Default is \code{FALSE}.} +\item{.all_versions}{(Not the same as \code{.all_rows} parameter of \code{epi_slide}.) +If \code{.all_versions = TRUE}, then the slide computation will be passed the +version history (all \code{version <= .version} where \code{.version} is one of the +requested \code{.versions}) for rows having a \code{time_value} of at least `.version +\itemize{ +\item before\verb{. Otherwise, the slide computation will be passed only the most recent }version\verb{for every unique}time_value\verb{. Default is }FALSE`. +}} \item{.ref_time_values}{Reference time values / versions for sliding computations; each element of this vector serves both as the anchor point