diff options
| author | hannajankowski <hkj@yorku.ca> | 2022-07-28 09:46:48 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-28 09:46:48 -0400 |
| commit | ed920e2ba184c5e7e56286e20b2b471657a3f8fe (patch) | |
| tree | 5f93e249eceafae2c5d0ea69c4cc76e2beca0e7e /R | |
| parent | b5cf62524a22ae6adf283cf2d96d2eccffcdc275 (diff) | |
Update ID.R
Diffstat (limited to 'R')
| -rw-r--r-- | R/ID.R | 2 |
1 files changed, 1 insertions, 1 deletions
@@ -7,7 +7,7 @@ #' 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 recommended. 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 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).
#'
#' @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}.
#'
|