X-Git-Url: https://git.nmode.ca/Rnaught/blobdiff_plain/9c1a5668803e735f034700c55028ffc0146f1e93..5f4889d4df5e94f194ef7f8b839496db04b17f4e:/R/ID.R

diff --git a/R/ID.R b/R/ID.R
index 7b0a1b9..cd991a4 100644
--- a/R/ID.R
+++ b/R/ID.R
@@ -9,37 +9,31 @@
 #' 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{ID} 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{ID} returns a single value, the estimate of R0.
 #'
 #' @examples
-#'
 #' ## ===================================================== ##
 #' ## Illustrate on weekly data                             ##
 #' ## ===================================================== ##
 #'
 #' NT <- c(1, 4, 10, 5, 3, 4, 19, 3, 3, 14, 4)
 #' ## obtain Rhat when serial distribution has mean of five days
-#' res1 <- ID(NT=NT, mu=5/7)
-#' res1$Rhat
+#' ID(NT=NT, mu=5/7)
 #' ## obtain Rhat when serial distribution has mean of three days
-#' res2	<- ID(NT=NT, mu=3/7)
-#' res2$Rhat
+#' ID(NT=NT, mu=3/7)
 #'
 #' ## ========================================================= ##
 #' ## Compute Rhat using only the first five weeks of data      ##
 #' ## ========================================================= ##
 #'
-#'
-#' res3 <- ID(NT=NT[1:5], mu=5/7)		# serial distribution has mean of five days
-#' res3$Rhat
+#' ID(NT=NT[1:5], mu=5/7) # serial distribution has mean of five days
 #'
 #' @export
 ID <- function(NT, mu) {
@@ -50,5 +44,5 @@ ID <- function(NT, mu) {
 
     R0_ID <- exp(sum(y) / TT)
 
-    return(list=c(Rhat=R0_ID, inputs=list(NT=NT, mu=mu)))
+    return(R0_ID)
 }