R/Data.R

In JMacDonaldPhD/Epidemics: Inference For Epidemics (one line, title case)

#'
#'
#' DATA
#'
#'
#'

# ==== Simulated Datasets ====

#' Simulated Epidemic Dataset
#'
#' Dataset containing the infection and removal times of a simulated homogeneous
#' epidemic with closed population N = 100, infectious process parameter beta = 0.0018
#' and infectious period parameter gamma = 0.15. This epidemic has a small population
#' with a low reproductive rate compared to the other simulated datasets in this
#' package.
#'
#'
#' @format R list of 7:
#' \describe{
#'   \item{N}{Size of Closed Population, in People}
#'   \item{final_size}{Number of individuals infected during course of the
#'                     epidemic, excluding the initial infected}
#'   \item{t_rem}{Removal Times of those removed during the course of the
#'                the epidemic, in a arbitrary unit of time}
#'   \item{t_inf}{Infection Times of those infected during the course of
#'                the epidemic}
#'   \item{beta}{Infectious Process Parameter}
#'   \item{gamma}{Infectious Period Parameter}
#'   \item{R0}{Basic Reproductive Rate}
#'   }
#' @source {Epidemic_Simulation Function}
#'

"Homo_LowPop_LowR0"

#' Simulated Epidemic Dataset
#'
#' Dataset containing the infection and removal times of a simulated homogeneous
#' epidemic with closed population N = 100, infectious process parameter beta = 0.0024
#' and infectious period parameter gamma = 0.15. This epidemic has a small population
#' with a medium reproductive rate compared to the other simulated datasets in this
#' package.
#'
#'
#' @format R list of 7:
#' \describe{
#'   \item{N}{Size of Closed Population, in People}
#'   \item{final_size}{Number of individuals infected during course of the
#'                     epidemic, excluding the initial infected}
#'   \item{t_rem}{Removal Times of those removed during the course of the
#'                the epidemic, in a arbitrary unit of time}
#'   \item{t_inf}{Infection Times of those infected during the course of
#'                the epidemic}
#'   \item{beta}{Infectious Process Parameter}
#'   \item{gamma}{Infectious Period Parameter}
#'   \item{R0}{Basic Reproductive Rate}
#'   }
#' @source {Epidemic_Simulation Function}
#'

"Homo_LowPop_MedR0"

#' Simulated Epidemic Dataset
#'
#' Dataset containing the infection and removal times of a simulated homogeneous
#' epidemic with closed population N = 100, infectious process parameter beta = 0.003
#' and infectious period parameter gamma = 0.15. This epidemic has a small population
#' with a high reproductive rate compared to the other simulated datasets in this
#' package.
#'
#'
#' @format R list of 7:
#' \describe{
#'   \item{N}{Size of Closed Population, in People}
#'   \item{final_size}{Number of individuals infected during course of the
#'                     epidemic, excluding the initial infected}
#'   \item{t_rem}{Removal Times of those removed during the course of the
#'                the epidemic, in a arbitrary unit of time}
#'   \item{t_inf}{Infection Times of those infected during the course of
#'                the epidemic}
#'   \item{beta}{Infectious Process Parameter}
#'   \item{gamma}{Infectious Period Parameter}
#'   \item{R0}{Basic Reproductive Rate}
#'   }
#' @source {Epidemic_Simulation Function}
#'

"Homo_LowPop_HighR0"

#' Simulated Epidemic Dataset
#'
#' Dataset containing the infection and removal times of a simulated homogeneous
#' epidemic with closed population N = 500, infectious process parameter beta = 0.00036
#' and infectious period parameter gamma = 0.15. This epidemic has a medium population
#' with a low reproductive rate compared to the other simulated datasets in this
#' package.
#'
#'
#' @format R list of 7:
#' \describe{
#'   \item{N}{Size of Closed Population, in People}
#'   \item{final_size}{Number of individuals infected during course of the
#'                     epidemic, excluding the initial infected}
#'   \item{t_rem}{Removal Times of those removed during the course of the
#'                the epidemic, in a arbitrary unit of time}
#'   \item{t_inf}{Infection Times of those infected during the course of
#'                the epidemic}
#'   \item{beta}{Infectious Process Parameter}
#'   \item{gamma}{Infectious Period Parameter}
#'   \item{R0}{Basic Reproductive Rate}
#'   }
#' @source {Epidemic_Simulation Function}
#'

"Homo_MedPop_LowR0"

#' Simulated Epidemic Dataset
#'
#' Dataset containing the infection and removal times of a simulated homogeneous
#' epidemic with closed population N = 500, infectious process parameter beta = 0.00048
#' and infectious period parameter gamma = 0.15. This epidemic has a medium population
#' with a medium reproductive rate compared to the other simulated datasets in this
#' package.
#'
#'
#' @format R list of 7:
#' \describe{
#'   \item{N}{Size of Closed Population, in People}
#'   \item{final_size}{Number of individuals infected during course of the
#'                     epidemic, excluding the initial infected}
#'   \item{t_rem}{Removal Times of those removed during the course of the
#'                the epidemic, in a arbitrary unit of time}
#'   \item{t_inf}{Infection Times of those infected during the course of
#'                the epidemic}
#'   \item{beta}{Infectious Process Parameter}
#'   \item{gamma}{Infectious Period Parameter}
#'   \item{R0}{Basic Reproductive Rate}
#'   }
#' @source {Epidemic_Simulation Function}
#'

"Homo_MedPop_MedR0"

#' Simulated Epidemic Dataset
#'
#' Dataset containing the infection and removal times of a simulated homogeneous
#' epidemic with closed population N = 500, infectious process parameter beta = 6 x 10^-4
#' and infectious period parameter gamma = 0.15. This epidemic has a medium population
#' with a high reproductive rate compared to the other simulated datasets in this
#' package.
#'
#'
#' @format R list of 7:
#' \describe{
#'   \item{N}{Size of Closed Population, in People}
#'   \item{final_size}{Number of individuals infected during course of the
#'                     epidemic, excluding the initial infected}
#'   \item{t_rem}{Removal Times of those removed during the course of the
#'                the epidemic, in a arbitrary unit of time}
#'   \item{t_inf}{Infection Times of those infected during the course of
#'                the epidemic}
#'   \item{beta}{Infectious Process Parameter}
#'   \item{gamma}{Infectious Period Parameter}
#'   \item{R0}{Basic Reproductive Rate}
#'   }
#' @source {Epidemic_Simulation Function}
#'

"Homo_MedPop_HighR0"

#' Simulated Epidemic Dataset
#'
#' Dataset containing the infection and removal times of a simulated homogeneous
#' epidemic with closed population N = 1000, infectious process parameter beta = 0.00018
#' and infectious period parameter gamma = 0.15. This epidemic has a large population
#' with a low reproductive rate compared to the other simulated datasets in this
#' package.
#'
#'
#' @format R list of 7:
#' \describe{
#'   \item{N}{Size of Closed Population, in People}
#'   \item{final_size}{Number of individuals infected during course of the
#'                     epidemic, excluding the initial infected}
#'   \item{t_rem}{Removal Times of those removed during the course of the
#'                the epidemic, in a arbitrary unit of time}
#'   \item{t_inf}{Infection Times of those infected during the course of
#'                the epidemic}
#'   \item{beta}{Infectious Process Parameter}
#'   \item{gamma}{Infectious Period Parameter}
#'   \item{R0}{Basic Reproductive Rate}
#'   }
#' @source {Epidemic_Simulation Function}
#'

"Homo_HighPop_LowR0"

#' Simulated Epidemic Dataset
#'
#' Dataset containing the infection and removal times of a simulated homogeneous
#' epidemic with closed population N = 1000, infectious process parameter beta = 0.00024
#' and infectious period parameter gamma = 0.15. This epidemic has a large population
#' with a medium reproductive rate compared to the other simulated datasets in this
#' package.
#'
#'
#' @format R list of 7:
#' \describe{
#'   \item{N}{Size of Closed Population, in People}
#'   \item{final_size}{Number of individuals infected during course of the
#'                     epidemic, excluding the initial infected}
#'   \item{t_rem}{Removal Times of those removed during the course of the
#'                the epidemic, in a arbitrary unit of time}
#'   \item{t_inf}{Infection Times of those infected during the course of
#'                the epidemic}
#'   \item{beta}{Infectious Process Parameter}
#'   \item{gamma}{Infectious Period Parameter}
#'   \item{R0}{Basic Reproductive Rate}
#'   }
#' @source {Epidemic_Simulation Function}
#'

"Homo_HighPop_MedR0"

#' Simulated Epidemic Dataset
#'
#' Dataset containing the infection and removal times of a simulated homogeneous
#' epidemic with closed population N = 1000, infectious process parameter beta = 0.0003
#' and infectious period parameter gamma = 0.15. This epidemic has a large population
#' with a high reproductive rate compared to the other simulated datasets in this
#' package.
#'
#'
#' @format R list of 7:
#' \describe{
#'   \item{N}{Size of Closed Population, in People}
#'   \item{final_size}{Number of individuals infected during course of the
#'                     epidemic, excluding the initial infected}
#'   \item{t_rem}{Removal Times of those removed during the course of the
#'                the epidemic, in a arbitrary unit of time}
#'   \item{t_inf}{Infection Times of those infected during the course of
#'                the epidemic}
#'   \item{beta}{Infectious Process Parameter}
#'   \item{gamma}{Infectious Period Parameter}
#'   \item{R0}{Basic Reproductive Rate}
#'   }
#' @source {Epidemic_Simulation Function}
#'

"Homo_HighPop_HighR0"