#' @title Summary Model Statistics

#'

#' @description Extracts and prints model statistics solved with \code{dcm}.

#'

#' @param object An \code{EpiModel} object of class \code{dcm}.

#' @param at Time step for model statistics.

#' @param run Model run number, for \code{dcm} class models with multiple runs

#' (sensitivity analyses).

#' @param digits Number of significant digits to print.

#' @param ... Additional summary function arguments (not used).

#'

#' @details

#' This function provides summary statistics for the main epidemiological

#' outcomes (state and transition size and prevalence) from a \code{dcm} model.

#' Time-specific summary measures are provided, so it is necessary to input a

#' time of interest. For multiple-run models (sensitivity analyses), input a

#' model run number. See examples below.

#'

#' @seealso \code{\link{dcm}}

#'

#' @method summary dcm

#' @keywords extract

#' @export

#'

#' @examples

#' ## Deterministic SIR model with varying act.rate

#' param <- param.dcm(inf.prob = 0.2, act.rate = 2:4, rec.rate = 1/3,

#' a.rate = 0.011, ds.rate = 0.01,

#' di.rate = 0.03, dr.rate = 0.01)

#' init <- init.dcm(s.num = 1000, i.num = 1, r.num = 0)

#' control <- control.dcm(type = "SIR", nsteps = 50)

#' mod <- dcm(param, init, control)

#' summary(mod, at = 25, run = 1)

#' summary(mod, at = 25, run = 3)

#' summary(mod, at = 26, run = 3)

#'

summary.dcm <- function(object, at, run = 1, digits = 3, ...) {

}

#' @title Summary Model Statistics

#'

#' @description Extracts and prints model statistics simulated with \code{icm}.

#'

#' @param object An \code{EpiModel} object of class \code{icm}.

#' @param at Time step for model statistics.

#' @param digits Number of significant digits to print.

#' @param ... Additional summary function arguments.

#'

#' @details

#' This function provides summary statistics for the main epidemiological

#' outcomes (state and transition size and prevalence) from an \code{icm} model.

#' Time-specific summary measures are provided, so it is necessary to input a

#' time of interest.

#'

#' @seealso \code{\link{icm}}

#'

#' @method summary icm

#' @keywords extract

#' @export

#'

#' @examples

#' ## Stochastic ICM SI model with 3 simulations

#' param <- param.icm(inf.prob = 0.2, act.rate = 1)

#' init <- init.icm(s.num = 500, i.num = 1)

#' control <- control.icm(type = "SI", nsteps = 50,

#' nsims = 5, verbose = FALSE)

#' mod <- icm(param, init, control)

#' summary(mod, at = 25)

#' summary(mod, at = 50)

#'

summary.icm <- function(object, at, digits = 3, ...) {

}

#' @title Summary Model Statistics

#'

#' @description Extracts and prints model statistics simulated with

#' \code{netsim}.

#'

#' @param object An \code{EpiModel} object of class \code{netsim}.

#' @param at Time step for model statistics.

#' @param digits Number of significant digits to print.

#' @param ... Additional summary function arguments.

#'

#' @details

#' This function provides summary statistics for the main epidemiological

#' outcomes (state and transition size and prevalence) from a \code{netsim}

#' model. Time-specific summary measures are provided, so it is necessary to

#' input a time of interest.

#'

#' @seealso \code{\link{netsim}}

#'

#' @method summary netsim

#' @keywords extract

#' @export

#'

#' @examples

#' \dontrun{

#' ## SI Model without Network Feedback

#' # Initialize network and set network model parameters

#' nw <- network_initialize(n = 100)

#' nw <- set_vertex_attribute(nw, "group", rep(1:2, each = 50))

#' formation <- ~edges

#' target.stats <- 50

#' coef.diss <- dissolution_coefs(dissolution = ~offset(edges), duration = 20)

#'

#' # Estimate the ERGM models (see help for netest)

#' est1 <- netest(nw, formation, target.stats, coef.diss, verbose = FALSE)

#'

#' # Parameters, initial conditions, and controls for model

#' param <- param.net(inf.prob = 0.3, inf.prob.g2 = 0.15)

#' init <- init.net(i.num = 10, i.num.g2 = 10)

#' control <- control.net(type = "SI", nsteps = 100, nsims = 5, verbose.int = 0)

#'

#' # Run the model simulation

#' mod <- netsim(est1, param, init, control)

#'

#' summary(mod, at = 1)

#' summary(mod, at = 50)

#' summary(mod, at = 100)

#' }

#'

summary.netsim <- function(object, at, digits = 3, ...) {

}

#' @title Summary for Network Model Fit

#'

#' @description Prints the summary model fit statistics for an ERGM or STERGM

#' fit.

#'

#' @param object An \code{EpiModel} object of class \code{netest}.

#' @param ... Additional summary function arguments.

#'

#' @method summary netest

#' @keywords internal

#' @export

#'

#' @details

#' This function is simply a wrapper function for \code{summary.ergm}.

#' Additionally, if the edges dissolution approximation was used to fit the

#' temporal ERGM, then the dissolution coefficient information will be printed.

#'

#' If the \code{fit} object is attached to the \code{netest} object, then

#' \code{summary.netest} will call \code{summary} on \code{fit} using the

#' \code{...} passed to \code{summary.netest}. Otherwise,

#' \code{summary.netest} will print the stored summary of the fit generated

#' in the original \code{netest} call, using the \code{...} passed to

#' \code{netest}.

#'

summary.netest <- function(object, ...) {

}