R/LRIBI_Info.R

In droglenc/fishWiDNR: Support for Wisconsin DNR Fisheries Analyses

#' Appendix A from Lyons et al. (2001).
#'
#' Species information in Appendix A from Lyons et al. (2001).
#'
#' @name LRIBI_AppendixA
#'
#' @docType data
#' 
#' @format A data frame with 90 observations on the following 10 variables.
#'\describe{
#'  \item{common.family}{A string that contains the species' common family name.}
#'  \item{common.name}{A string that contains the species' common name.}
#'  \item{sci.family}{A string that contains the species' scientific family name.}
#'  \item{sci.name}{A string that contains the species' scientific name.}
#'  \item{origin}{A string that indicates whether the species is \code{Native} or \code{Exotic}.}
#'  \item{tolerance}{A string that indicates whether the species is \code{Tolerant}, \code{Intolerant}, or \code{Other}.}
#'  \item{feeding}{A string that indicates whether the species is a \code{Carnivore}, \code{Insectivore}, \code{Omnivore}, or \code{Other}.}
#'  \item{habitat}{A string that indicates whether the species' main habiat is in \code{River}s, \code{River-Large}, \code{Large} rivers, or \code{Other}.}
#'  \item{spawning}{A string that indicates whether the species' main spawning habitat is \code{Lithophil} or \code{Other}.}
#'  \item{round.sucker}{A string that indicates whether the species is considered a round.sucker (\code{Yes}) or not (\code{No}).}
#'}
#'
#' @source From Appendix A in Lyons, J., R.R. Piette, and K.W. Niermeyer. 2001. Development, validation, and application of a fish-based index of biotic integrity for Wisconsin's large warmwater rivers. Transactions of the American Fisheries Society 130:1077-1094.
#' 
#' @author Derek H. Ogle and Joseph T. Mrnak.
#' 
#' @keywords datasets
#' 
#' @examples
#' LRIBI_AppendixA
NULL


#' Table 3 from Lyons et al. (2001).
#'
#' IBI metric cutoffs in Table 3 from Lyons et al. (2001).
#'
#' @name LRIBI_Table3
#'
#' @docType data
#' 
#' @format A data frame with 20 observations on the following 4 variables.
#'\describe{
#'  \item{ecoregion}{A string that indicates whether the values pertain to the \code{North} or \code{South} ecoregions.}
#'  \item{metric}{A string that idicates the metric name.}
#'  \item{fair}{A numeric value that indicates the minimum value for being considered of \dQuote{Fair} quality, except for \code{metric="perc.DELT"} where it is the maximum value.}
#'  \item{good}{A numeric value that indicates the minimum value for being considered of \dQuote{Good} quality, except for \code{metric="perc.DELT"} where it is the maximum value.}
#'}
#'
#' @source From Table 3 in Lyons, J., R.R. Piette, and K.W. Niermeyer. 2001. Development, validation, and application of a fish-based index of biotic integrity for Wisconsin's large warmwater rivers. Transactions of the American Fisheries Society 130:1077-1094.
#' 
#' @author Derek H. Ogle and Joseph T. Mrnak.
#' 
#' @keywords datasets
#' 
#' @examples
#' LRIBI_Table3
NULL


#' Ecoregions for Wisconsin counties.
#'
#' Ecoregions for Wisconsin counties according to Figure 1 in Lyons et al. (2001).
#'
#' @name LRIBI_Ecoregions
#'
#' @docType data
#' 
#' @format A data frame with 72 observations on the following 2 variables.
#'\describe{
#'  \item{county}{A string that is the county name.}
#'  \item{ecoregion}{A string that idicates the county's ecoregion: \code{North}, \code{South}, or \code{Both}.}
#'}
#'
#' @source Estimated from Figure 1 in Lyons, J., R.R. Piette, and K.W. Niermeyer. 2001. Development, validation, and application of a fish-based index of biotic integrity for Wisconsin's large warmwater rivers. Transactions of the American Fisheries Society 130:1077-1094.
#' 
#' @author Derek H. Ogle and Joseph T. Mrnak.
#' 
#' @keywords datasets
#' 
#' @examples
#' LRIBI_Ecoregions
NULL