Merge pull request #92 from dajmcdon/km/growth_rate

Km/growth rate

Author: ChloeYou

R/growth_rate.R

@@ -100,6 +100,17 @@
 #'   user.
 #' 
 #' @export
+#' @examples
+#' # COVID cases growth rate by state using default method relative change
+#' jhu_csse_daily_subset %>% 
+#'   group_by(geo_value) %>% 
+#'   mutate(cases_gr = growth_rate(x = time_value,  y = cases))
+#' 
+#' # Log scale, degree 4 polynomial and 6-fold cross validation
+#' jhu_csse_daily_subset %>% 
+#'   group_by(geo_value) %>% 
+#'   mutate(gr_poly = growth_rate( x = time_value, y = cases, log_scale = TRUE,  ord = 4,  k = 6))
+
 growth_rate = function(x = seq_along(y), y, x0 = x,
                        method = c("rel_change", "linear_reg",
                                   "smooth_spline", "trend_filter"),