R/hhss_documentation.R

In peterdonati/hhss: Hunter Harvest Survey Simulations

#' hhss: Hunter Harvest Survey Simulations, and Estimates of Harvest.
#'
#' There are three types of functions within this package:
#' \code{\link{pop}},
#' \code{\link{survey}},
#' \code{\link{est}} \cr\cr
#'
#' The general flow is designed to go:\cr
#' \enumerate{
#'     \item Make a population with \code{pop()}\cr
#'     \item Take that population and put it through the desired simulations
#'         using the \code{survey} functions\cr
#'     \item Estimate total harvest from those simulations using \code{est()}
#'  }
#'
#' @docType package
#' @name hhss
NULL