Update docs with summarise option

epiverse-trace · May 7, 2024 · 6b5e296 · 6b5e296
1 parent 6a3078a
commit 6b5e296
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/R/scenario_comparison.R b/R/scenario_comparison.R
@@ -122,10 +122,11 @@
 #'   scenarios = scenarios
 #' )
 #'
-#' # Set summarise = FALSE to apply custom summary functions
+#' # Set summarise = FALSE to get raw difference data
 #' outcomes_averted(
 #'   baseline = baseline,
-#'   scenarios = scenarios
+#'   scenarios = scenarios,
+#'   summarise = FALSE
 #' )
 outcomes_averted <- function(baseline,
                              scenarios,

diff --git a/man/outcomes_averted.Rd b/man/outcomes_averted.Rd