R/package.R

In lshtm-vimc/prime: PRIME -- Papillomavirus Rapid Interface for Modelling and Economics

# package.R - This file includes introductory information of package.

#' prime: Papillomavirus Rapid Interface for Modelling and Economics (PRIME).
#'
#' PRIME stands for “Papillomavirus Rapid Interface for Modelling and Economics”.
#' The R package is based of the spreadsheet-based tool (see http://primetool.org).
#'
#' @section PRIME provides estimates of:
#' \describe{
#' \item{The magnitude of the burden of cervical cancer.}{}
#' \item{The impact of introducing HPV vaccination for girls prior to sexual debut.}{}
#' \item{Healthcare costs incurred as a result of cervical cancer treatment.}{}
#' \item{Costs associated with vaccination.}{}
#' \item{Long-term savings which may result from a vaccination program.}{}
#' }
#'
#' @docType package
#' @name prime
NULL