Edit docs

[Rnaught] / R / IDEA.R

diff --git a/R/IDEA.R b/R/IDEA.R
index 53cfaa7626b2fc31d18052faaf909d1947aead3b..20a94016707747120b5e795ca6bd19af00db6b4f 100644 (file)
--- 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.\r
 #' The method assumes that the mean of the serial distribution (sometimes called the serial interval) is known.\r
 #' The final estimate can be quite sensitive to this value, so sensitivity testing is strongly recommended.\r
-#' Users should be careful about units of time (e.g. are counts observed daily or weekly?) when implementing.\r
+#' Users should be careful about units of time (e.g., are counts observed daily or weekly?) when implementing.\r
 #'\r
-#' @param NT Vector of case counts\r
-#' @param mu Mean of the serial distribution (needs to match case counts in time units; for example, if case counts are\r
-#'           weekly and the serial distribution has a mean of seven days, then \code{mu} should be set to one, if case\r
-#'           counts are daily and the serial distribution has a mean of seven days, then \code{mu} should be set to seven)\r
+#' @param NT Vector of case counts.\r
+#' @param mu Mean of the serial distribution. This needs to match case counts in time units. For example, if case counts\r
+#'           are weekly and the serial distribution has a mean of seven days, then \code{mu} should be set to one. If case\r
+#'           counts are daily and the serial distribution has a mean of seven days, then \code{mu} should be set to seven.\r
 #'\r
-#' @return \code{IDEA} returns a list containing the following components: \code{Rhat} is the estimate of R0 and\r
-#'         \code{inputs} is a list of the original input variables \code{NT, mu}.\r
+#' @return \code{IDEA} returns a single value, the estimate of R0.\r
 #'\r
 #' @examples\r
 #' ## ===================================================== ##\r