Skip to content

Commit

Permalink
Correct epidemic_size() documentation
Browse files Browse the repository at this point in the history
Co-authored-by: James Azam <[email protected]>
  • Loading branch information
pratikunterwegs and jamesmbaazam authored Apr 22, 2024
1 parent 7ee37fb commit a0226c5
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions R/helpers.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 `<data.table>`.
#' 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.
Expand Down

0 comments on commit a0226c5

Please sign in to comment.