summaryrefslogtreecommitdiff
path: root/R/WP_known.R
diff options
context:
space:
mode:
authorNaeem Model <me@nmode.ca>2023-06-21 09:09:08 +0000
committerNaeem Model <me@nmode.ca>2023-06-21 09:09:08 +0000
commite0988851b26668ec69131e22a0815ce6f85b94c4 (patch)
tree19eaeea0cb67a3da8daf7c1a289283ef1f186123 /R/WP_known.R
parent08d0f6be2aa45d3ba417390bb270d831a2b51f8b (diff)
Edit docs
Diffstat (limited to 'R/WP_known.R')
-rw-r--r--R/WP_known.R7
1 files changed, 4 insertions, 3 deletions
diff --git a/R/WP_known.R b/R/WP_known.R
index 563b7ae..2c54bce 100644
--- a/R/WP_known.R
+++ b/R/WP_known.R
@@ -3,9 +3,10 @@
#' This is a background/internal function called by \code{WP}. It computes the maximum
#' likelihood estimator of R0 assuming that the serial distribution is known and finite discrete.
#'
-#' @param NT vector of case counts
-#' @param p discretized version of the serial distribution
-#' @return The function returns \code{Rhat}, the maximum likelihood estimator of R0.
+#' @param NT Vector of case counts.
+#' @param p Discretized version of the serial distribution.
+#'
+#' @return The function returns the maximum likelihood estimator of R0.
#'
#' @export
WP_known <- function(NT, p) {