From a0226c5e1628ba6238c3c38d6c1d03a388d86bc8 Mon Sep 17 00:00:00 2001 From: Pratik Gupte Date: Mon, 22 Apr 2024 13:47:29 +0100 Subject: [PATCH] Correct epidemic_size() documentation Co-authored-by: James Azam --- R/helpers.R | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/R/helpers.R b/R/helpers.R index c1696dea..52a821d9 100644 --- a/R/helpers.R +++ b/R/helpers.R @@ -91,8 +91,8 @@ #' @param data A table of model output, typically #' the output of [model_default()] or similar functions. #' @param stage A numeric vector for the stage of the epidemic at which to -#' return the epidemic size; here, 0.0 represents the initial conditions of the -#' epidemic (0% of model time), while 1.0 represents the end of the epidemic +#' return the epidemic size; here, 0.0 represents the start time of the epidemic, i.e., the initial conditions of the +#' epidemic simulation, while 1.0 represents the end of the epidemic simulation. #' model (100% of model time). Defaults to 1.0, at which stage returned values #' represent the _final size_ of the epidemic. #' This value is overridden by any values passed to the `time` argument. @@ -111,7 +111,6 @@ #' be simplified to a vector with one element for each demographic group. #' If the length of `stage` or `time` is $>$ 1, this argument is overridden and #' the data are returned as a ``. -#' group. #' @return #' If `simplify == TRUE` and a single timepoint is requested, returns a vector #' of epidemic sizes of the same length as the number of demographic groups.