add return values for some funs

This was flagged by CRAN and I completely agree with them!

R/age-categories.R

@@ -24,6 +24,8 @@
 #' you want to have after your highest age group. The default is "+" producing
 #' e.g. 80+
 #'
+#' @return a factor representing age ranges, open at the upper end of the range.
+#'
 #' @export
 #' @examples
 #'
@@ -44,8 +46,6 @@
 #'   table()
 #' })
 #' }
-
-
 age_categories <- function(x, breakers = NULL, lower = 0, upper = NULL, by = 10,
                            separator = "-", ceiling = FALSE, above.char = "+") {
 

R/cfr.R

@@ -14,7 +14,7 @@
 #'
 #' @param conf_level a number representing the confidence level for which to
 #'   calculate the confidence interval. Defaults to 0.95, representing a 95%
-#'   confidence interval.
+#'   confidence interval using [binom::binom.wilson()]
 #'
 #' @param multiplier The base by which to multiply the output:
 #'  - `multiplier = 1`: ratio between 0 and 1
@@ -27,7 +27,13 @@
 #'   the total value across all groups.
 #'
 #' @param digits if `mergeCI = TRUE`, this determines how many digits are printed
+#' 
+#' @return a data frame with five columns that represent the numerator,
+#'   denominator, rate, lower bound, and upper bound.
 #'
+#'  - `attack_rate()`: cases, population, ar, lower, upper
+#'  - `case_fatality_rate()`: deaths, population, cfr, lower, upper
+#'  
 #' @export
 #'
 #' @rdname attack_rate

R/inline_fun.R

@@ -59,6 +59,8 @@ fmt_ci_df <- function(x, e = 3, l = e + 1, u = e + 2, digits = 2, percent = TRUE
 #' @param x a data frame
 #'
 #' @param ... an expression or series of expressions to pass to [dplyr::filter()]
+#' 
+#' @return a one-element character vector of the format "n (%)"
 #'
 #' @export
 #' @examples

R/relabel_proportions.R

@@ -10,6 +10,7 @@
 #' @param ... a series of keys and values to replace columns that match specific
 #'   patterns.
 #' @export
+#' @return a data frame.
 #' @author Zhian N. Kamvar
 #' @examples
 #'

R/unite_ci.R

@@ -13,6 +13,9 @@
 #' @param m100 `TRUE` if the result should be multiplied by 100
 #' @param percent `TRUE` if the result should have a percent symbol added.
 #' @param ci `TRUE` if the result should include "CI" within the braces (defaults to FALSE)
+#' 
+#' @return a modified data frame with merged columns or one additional column
+#'   representing the estimate and confidence interval
 #'
 #' @export
 #' @examples