R/pkgname.R

In bbolker/McMasterPandemic: Pandemic Model

##
## vignette("rd",package="roxygen2")
##

## dealing with LaTeX in roxygen documentation:
## https://cran.r-project.org/doc/manuals/r-devel/R-exts.html#Conditional-text

##'
##' \pkg{McMasterPandemic}
##'
##' This R package provides compartmental epidemic models for
##' forecasting and analysis of infectious diseases
##'
##' The \href{https://canmod.github.io/macpan-book/}{user guide} provides
##' extensive information on the
##' \href{https://canmod.github.io/macpan-book/index.html#history-and-motivation}{history}
##' of McMasterPandemic,
##' \href{https://canmod.github.io/macpan-book/index.html#installation}{installation},
##' building a
##' \href{https://canmod.github.io/macpan-book/model-initialization.html}{simple SIR model},
##' and a library of
##' \href{https://canmod.github.io/macpan-book/examples.html}{examples}.
##'
##' If you clicked on the \href{https://canmod.github.io/macpan-book/index.html#history-and-motivation}{history}
##' link above, you will have read that \code{McMasterPandemic} started out as
##' a specific set of models for the COVID-19 pandemic in Canada.
##' To get started with this functionality for using these specific models,
##' read the introductory vignette, which can be viewed via
##' \code{vignette("getting_started",package="McMasterPandemic")}.
##' Use \code{browseVignettes("McMasterPandemic")} to find other vignettes
##' for this package.
##'
"_PACKAGE"