]> nmode's Git Repositories - Rnaught/commitdiff
Update IDEA.R
authorhannajankowski <hkj@yorku.ca>
Thu, 28 Jul 2022 13:57:50 +0000 (09:57 -0400)
committerGitHub <noreply@github.com>
Thu, 28 Jul 2022 13:57:50 +0000 (09:57 -0400)
R/IDEA.R

index 3456f6cab2bf0f39d24df1e6cd16577c746b1286..fdc83dc475962f42872a3d4233a836655b60f719 100644 (file)
--- a/R/IDEA.R
+++ b/R/IDEA.R
@@ -4,7 +4,7 @@
 #'\r
 #'This method is closely related to that implemented in \code{ID}. The method is based on an incidence decay model.   The estimate of R0 is the value which minimizes the sum of squares between observed case counts and cases counts 'expected' under the model.\r
 #'\r
-#' 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.  \r
+#' 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.  \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 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)\r