Skip to content

Commit 730bc55

Browse files
committed
Further NEWS rewording
1 parent 2baa9e0 commit 730bc55

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

NEWS.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ Pre-1.0.0 numbering scheme: 0.x will indicate releases, while 0.x.y will indicat
66

77
## Breaking changes
88

9-
- `growth_rate()` with `method = "trendfilter"` now uses the `{trendfilter}`
10-
package rather than `{genlasso}`; results for this method will be different
11-
than before. In order to make `{epiprocess}` installation easier for users
12-
without a compiler, we have placed `{trendfilter}` in Suggests:; if you want
13-
to use `method = "trendfilter"` you will need to manually this dependency
14-
(e.g., with `remotes::install_github("glmgen/trendfilter")`). The interface
15-
for passing arguments to the `"smooth_spline"` and `"trend_filter"` methods
16-
has also changed.
9+
- `growth_rate()` argument order and names have changed. You will need to
10+
rewrite `growth_rate(x, y)` as `growth_rate(y, x)`. The interface for passing
11+
arguments to the `"smooth_spline"` and `"trend_filter"` methods has also
12+
changed. Finally, `growth_rate()` with `method = "trendfilter"` now uses the
13+
`{trendfilter}` package rather than `{genlasso}`; results for this method will
14+
be different than before. In order to make `{epiprocess}` installation easier
15+
for users without a compiler, we have placed `{trendfilter}` in Suggests:; if
16+
you want to use `method = "trendfilter"` you will need to manually install
17+
this dependency (e.g., with `remotes::install_github("glmgen/trendfilter")`).
1718
- In `revision_summary()`:
1819
- Output now uses the name `lag_near_latest` instead of `time_near_latest`. To
1920
migrate, update references to `time_near_latest` to `lag_near_latest`.

R/growth_rate.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
#' vignette](https://cmu-delphi.github.io/epiprocess/articles/growth_rate.html)
66
#' for examples.
77
#'
8+
#' @param y Signal values.
89
#' @param x Design points corresponding to the signal values `y`. Default is
910
#' `seq_along(y)` (that is, equally-spaced points from 1 to the length of
1011
#' `y`).
11-
#' @param y Signal values.
1212
#' @param x0 Points at which we should estimate the growth rate. Must be a
1313
#' contained in the range of `x` (no extrapolation allowed). Default is `x`.
1414
#' @param method Either "rel_change", "linear_reg", "smooth_spline", or

0 commit comments

Comments
 (0)