Updated examples from Chloe's comment.

Author: kenmawer

R/growth_rate.R

@@ -101,14 +101,15 @@
 #' 
 #' @export
 #' @examples
-#' # California's growth rate in COVID cases
-#'  mutate(jhu_csse_daily, gr = growth_rate(time_value,cases))
+#' # 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
-#' growth_rate(
-#'   x = jhu_csse_daily$time_value, y = jhu_csse_daily$cases,
-#'   log_scale = TRUE, ord = 4, k = 6
-#' )
+#' 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",