update outdated create_summary_stats function return documentation

R/epiparameter-utils.R

@@ -214,6 +214,7 @@ create_region <- function(continent = NA_character_,
   )
 }
 
+# nolint start: line_length_linter
 #' Specify reported summary statistics
 #'
 #' @description A helper function when creating an `<epiparameter>` object to
@@ -259,11 +260,11 @@ create_region <- function(continent = NA_character_,
 #' If quantiles are not provided a default empty vector with the 2.5th, 5th,
 #' 25th, 75th, 95th, 97.5th quantiles are supplied.
 #'
-#' @return A nested list of summary statistics. The highest level are
-#' - `$centre_spread`
-#' - `$quantiles`
-#' - `$range`
-#' - `$dispersion`
+#' @return A list of summary statistics. The output list has element names
+#' equal to the function arguments:
+#' \preformatted{
+#' `r paste("$", names(formals(create_summary_stats)), sep = "", collapse = "\n")`
+#' }
 #' @export
 #'
 #' @examples
@@ -286,6 +287,7 @@ create_region <- function(continent = NA_character_,
 #'   lower_range = 1,
 #'   upper_range = 13
 #' )
+# nolint end: line_length_linter
 create_summary_stats <- function(mean = NA_real_,
                                  mean_ci_limits = c(NA_real_, NA_real_),
                                  mean_ci = NA_real_,