Create .Rbuildignore

[Rnaught] / R / ID.R

diff --git a/R/ID.R b/R/ID.R
index b5fc8c2e78c7139aa4e696510bc3bf34e1921400..cd991a43ce6e07a93be86a7833839930c22a8b24 100644 (file)
--- a/R/ID.R
+++ b/R/ID.R
@@ -9,15 +9,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
 #' 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
 #'\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
 #'\r

-#' @return \code{ID} 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{ID} returns a single value, the estimate of R0.\r

 #'\r
 #' @examples\r
 #' ## ===================================================== ##\r
 #'\r
 #' @examples\r
 #' ## ===================================================== ##\r