From e0988851b26668ec69131e22a0815ce6f85b94c4 Mon Sep 17 00:00:00 2001 From: Naeem Model Date: Wed, 21 Jun 2023 09:09:08 +0000 Subject: Edit docs --- R/IDEA.R | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) (limited to 'R/IDEA.R') diff --git a/R/IDEA.R b/R/IDEA.R index 53cfaa7..20a9401 100644 --- a/R/IDEA.R +++ b/R/IDEA.R @@ -10,15 +10,14 @@ #' This method is based on an approximation of the SIR model, which is most valid at the beginning of an epidemic. #' The method assumes that the mean of the serial distribution (sometimes called the serial interval) is known. #' The final estimate can be quite sensitive to this value, so sensitivity testing is strongly recommended. -#' Users should be careful about units of time (e.g. are counts observed daily or weekly?) when implementing. +#' Users should be careful about units of time (e.g., are counts observed daily or weekly?) when implementing. #' -#' @param NT Vector of case counts -#' @param mu Mean of the serial distribution (needs to match case counts in time units; for example, if case counts are -#' weekly and the serial distribution has a mean of seven days, then \code{mu} should be set to one, if case -#' counts are daily and the serial distribution has a mean of seven days, then \code{mu} should be set to seven) +#' @param NT Vector of case counts. +#' @param mu Mean of the serial distribution. This needs to match case counts in time units. For example, if case counts +#' are weekly and the serial distribution has a mean of seven days, then \code{mu} should be set to one. If case +#' counts are daily and the serial distribution has a mean of seven days, then \code{mu} should be set to seven. #' -#' @return \code{IDEA} returns a list containing the following components: \code{Rhat} is the estimate of R0 and -#' \code{inputs} is a list of the original input variables \code{NT, mu}. +#' @return \code{IDEA} returns a single value, the estimate of R0. #' #' @examples #' ## ===================================================== ## -- cgit v1.2.3