R/parameter_details.R

In idmodelr: Infectious Disease Model Library and Utilities

#' Parameter Details
#'
#'Details on the parameters used in models implemented in `idmodelr`.
#' @format A data frame with 14 rows and 6 variables.
#' \describe{
#'       \item{parameter}{Name of the parameter.}
#'       \item{parameter_family}{Descriptive parameter family (i.e. transmission).}
#'       \item{description}{What is this parameter.}
#'       \item{type}{What type of parameter is this (i.e rate, proportion, probability etc.).}
#'       \item{risk_stratified}{Is this parameter used in risk stratified models (yes/no).}
#'       \item{non_exponential}{Is this parameter a non-exponential rate (yes/no).}
#' }
"parameter_details"