Package-wide documentation

[DavidBard]

Assume your username is 'uuu'. Assume your package name is 'ppp'. Create ./R/ppp-package.R. Make sure there's an empty last line (not even a space or tab).

#' @docType package
#' @name ppp-package
#' @aliases ppp
#'
#' @title Short-book-title
#'
#' @description
#' The description should be a longer complete sentence.
#'
#' TODO: consider adding links to your project's funders.
#'
#' @note
#' The most recent development version is available through [GitHub](https://github.com/uuu/ppp) by
#' running.
#'
#' `devtools::install_github('uuu/ppp')`
#' (make sure [devtools](https://cran.r-project.org/package=devtools) is already installed).
#' If you're having trouble with the package, please install the development version.  If this doesn't solve
#' your problem, please create a [new issue](https://github.com/uuu/ppp/issues), or email uuu.
#'
#' @examples
#' \dontrun{
#' # Install/update ReferralExposure with the development version from GitHub
#' #install.packages('devtools') #Uncomment if `devtools` isn't installed already.
#' devtools::install_github('uuu/ppp')
#' }
NULL