X-Git-Url: https://git.nmode.ca/Rnaught/blobdiff_plain/2a6de5fb5270f70eb83233a10bb84301c119cc16..2d34b71c7a8da7fd0fac59b934145286b2be7b1f:/man/seq_bayes.Rd diff --git a/man/seq_bayes.Rd b/man/seq_bayes.Rd index 41445a9..9cb6db9 100644 --- a/man/seq_bayes.Rd +++ b/man/seq_bayes.Rd @@ -30,7 +30,7 @@ If \code{post} is identical to \code{TRUE}, a list containing the following components is returned: \itemize{ \item \code{supp} - the support of the posterior distribution of R0 -\item \code{pmf} - the probability mass function of the posterior distribution +\item \code{pmf} - the probability mass function of the posterior distribution of R0 } Otherwise, if \code{post} is identical to \code{FALSE}, only the estimate of R0 is @@ -80,13 +80,21 @@ seq_bayes(cases, mu = 3 / 7) # believed to be at most 4. estimate <- seq_bayes(cases, mu = 1, kappa = 4) -# Same as above, but return the posterior distribution instead of the +# Same as above, but return the posterior distribution of R0 instead of the # estimate. posterior <- seq_bayes(cases, mu = 1, kappa = 4, post = TRUE) +# Display the support and probability mass function of the posterior. +posterior$supp +posterior$pmf + # Note that the following always holds: estimate == sum(posterior$supp * posterior$pmf) } \references{ \href{https://doi.org/10.1371/journal.pone.0002185}{Bettencourt and Riberio (PloS One, 2008)} } +\seealso{ +\code{vignette("seq_bayes_post", package = "Rnaught")} for examples of +using the posterior distribution. +}