Add an example to the SISe method

stewid · Mar 2, 2017 · 36b5ceb · 36b5ceb
1 parent bad895d
commit 36b5ceb
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/R/SISe.R b/R/SISe.R
@@ -54,6 +54,27 @@ setClass("SISe", contains = c("siminf_model"))
 ##' @return \code{SISe}
 ##' @include check_arguments.R
 ##' @export
+##' @examples
+##' ## Create an SISe model object.
+##' model <- SISe(u0 = data.frame(S = 99, I = 1),
+##'               tspan = 1:1000,
+##'               phi = 0,
+##'               upsilon = 0.017,
+##'               gamma   = 0.1,
+##'               alpha   = 1,
+##'               beta_t1 = 0.19,
+##'               beta_t2 = 0.085,
+##'               beta_t3 = 0.075,
+##'               beta_t4 = 0.185,
+##'               end_t1  = 91,
+##'               end_t2  = 182,
+##'               end_t3  = 273,
+##'               end_t4  = 365,
+##'               epsilon = 0.000011)
+##'
+##' ## Run the SISe model and plot the result.
+##' result <- run(model, seed = 4)
+##' plot(result)
 SISe <- function(u0,
                  tspan,
                  events  = NULL,

diff --git a/man/SISe.Rd b/man/SISe.Rd