Skip to content

Commit d9682da

Browse files
committed
Fix some outdated docs, refine wording on others
- Remove reference to `n` in slide vignette intro. - Update .Rd files with some older roxygen changes. - Fix "`time_value`s" -> "time steps" in `detect_outlr_rm` docs, and slightly tweak wording.
1 parent 0fec3ae commit d9682da

File tree

4 files changed

+25
-27
lines changed

4 files changed

+25
-27
lines changed

R/outliers.R

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,10 @@ detect_outlr = function(x = seq_along(y), y,
128128
#' `y`).
129129
#' @param y Signal values.
130130
#' @param n Number of time steps to use in the rolling window. Default is 21.
131-
#' This value is centrally aligned. When `n` is an odd number, the
132-
#' rolling range goes between `(n-1)/2` `time_value`s before to `(n-1)/2`
133-
#' `time_value`s after. When `n` is even, then the
134-
#' rolling range goes between `n/2-1` `time_value`s before to `n/2`
135-
#' `time_value`s after.
131+
#' This value is centrally aligned. When `n` is an odd number, the rolling
132+
#' window extends from `(n-1)/2` time steps before each design point to `(n-1)/2`
133+
#' time steps after. When `n` is even, then the rolling range extends from
134+
#' `n/2-1` time steps before to `n/2` time steps after.
136135
#' @param log_transform Should a log transform be applied before running outlier
137136
#' detection? Default is `FALSE`. If `TRUE`, and zeros are present, then the
138137
#' log transform will be padded by 1.

man/detect_outlr_rm.Rd

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

man/epi_slide.Rd

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

vignettes/slide.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A central tool in the `epiprocess` package is `epi_slide()`, which is based on
1111
the powerful functionality provided in the
1212
[`slider`](https://cran.r-project.org/web/packages/slider) package. In
1313
`epiprocess`, to "slide" means to apply a computation---represented as a
14-
function or formula---over a running window of `n` time steps. Suitable
14+
function or formula---over a sliding/rolling data window. Suitable
1515
groupings can always be achieved by a preliminary call to `group_by()`.
1616

1717
By default, the meaning of one time step is inferred from the `time_value`

0 commit comments

Comments
 (0)