R/artiFISHal-package.R

In JVAdams/artiFISHal: A Pelagic Fish Community Simulator

#' Pelagic Fish Community Simulator
#'
#' \pkg{artiFISHal} is a pelagic fish community simulator, which can be used to
#' create artificial lakes and populate them with known numbers of fish
#' (identified in species-size groups) to mimic pelagic fish communities.
#' \pkg{artiFISHal} can then be used to sample these fish with virtual acoustic
#' and midwater trawl surveys.
#'
#' An example of how to use the functions in \pkg{artiFISHal} is given in this
#' vignette
#' \href{https://github.com/JVAdams/artiFISHal/blob/master/Vignette.md}{[link]}.
#' Use \code{\link{SimFish}} to create an artificial lake and populate it with
#' known numbers of fish (identified in species-size groups)
#' to mimic pelagic fish communities.
#' Use \code{\link{SampFish}} to sample the fish population with virtual
#' acoustic and midwater trawl surveys.
#'
#' Yule et al. (2013) used \pkg{artiFISHal}
#' to evaluate several different approaches for estimating the biomass of
#' pelagic fish species in the Great Lakes.
#'
#' \emph{U.S. Geological Survey} (USGS) Computer Program \pkg{artiFISHal}
#' version 0.0.0.9001.
#' Written by Jean V. Adams, USGS - Great Lakes Science Center
#' \href{http://www.glsc.usgs.gov/}{glsc.usgs.gov}, Ann Arbor, Michigan, USA.
#' Written in programming language R (R Core Team, 2015,
#' \href{http://www.R-project.org}{R-project.org}), version 3.2.3 (2015-12-10).
#' Run on a PC with Intel(R) Core(TM) I7-4600m CPU, 2.90 GHz processor,
#' 16.0 GB RAM, and
#' Microsoft Windows 7 Enterprise operating system 2009 Service Pack 1.
#' Source code is available from Jean V. Adams on GitHub
#' \href{https://github.com/JVAdams/artiFISHal}{github.com/JVAdams/LW1949},
#' \emph{jvadams (at) usgs (dot) gov}.
#'
#' \emph{Disclaimer:}  Although this program has been used by the USGS,
#' no warranty, expressed or implied, is made by the USGS or the United States
#' Government as to the accuracy and functioning of the program and related
#' program material nor shall the fact of distribution constitute any such
#' warranty, and no responsibility is assumed by the USGS in connection
#' therewith.
#'
#' @references
#'   Yule, DL, JV Adams, DM Warner, TR Hrabik, PM Kocovsky, BC Weidel,
#'   LG Rudstam, and PJ Sullivan.  2013.
#'   Evaluating analytical approaches for estimating pelagic fish biomass using
#'   simulated fish communities.
#'   Canadian Journal of Fisheries and Aquatic Sciences 70:1845-1857.
#'   \emph{http://www.nrcresearchpress.com/doi/abs/10.1139/cjfas-2013-0072#.U1KYxPldXTQ}
#'
#' @name artiFISHal
#' @docType package
NULL