ensured all rate_ratio() examples pass

Author: WetRobot

R/incidence_rates_utils.R

@@ -22,17 +22,30 @@
 #' 
 #' @examples 
 #' \dontrun{
-#' # two rate ratios
-#' rate_ratio(rate_obj1, rate_obj2, SE.method = TRUE) 
+#' # two rate ratios; silly example with female rectal / breast cancer 
+#' ## mortality rates
+#' data("sire", package = "popEpi")
+#' data("sibr", package = "popEpi")
+#' 
+#' BL <- list(per = 2000:2005)
+#' 
+#' re <- lexpand(sire, birth = "bi_date", entry = "dg_date", exit = "ex_date",
+#'               status = status == 1, breaks = BL, aggre = list(per))
+#' br <- lexpand(sibr, birth = "bi_date", entry = "dg_date", exit = "ex_date",
+#'               status = status == 1, breaks = BL, aggre = list(per))
+#' 
+#' r_re <- rate(re, obs = "from0to1", pyrs = "pyrs")
+#' r_br <- rate(br, obs = "from0to1", pyrs = "pyrs")
+#' 
+#' rate_ratio(r_re, r_br, SE.method = TRUE)
+#' }
 #' 
 #' # manually set rates (0.003 and 0.005) and SEs (0.001 and 0.002)
 #' # so that x = y = c('rate', 'SE')
 #' rate_ratio(x= c(0.003, 0.001), y= c(0.005, 0.002), SE.method = TRUE) 
 #' 
 #' # observed numbers (10 and 20) and person-years (30000 and 40000):
 #' rate_ratio(x = c(10, 30000), y = c(20, 40000), SE.method = FALSE)
-#' }
-#' 
 #' 
 #' @seealso \code{\link{rate}}
 #'