Create package help topic

[Rnaught] / man / seq_bayes.Rd

diff --git a/man/seq_bayes.Rd b/man/seq_bayes.Rd
index 41445a9f462aacfce151dd8a43bc5e1f11400b3a..9cb6db99cc1fdc5b5acaa1ccceefb381b64a5b95 100644 (file)
--- 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.
+}