R/habitat.R

In danStich/anadrofish: Anadromous Fish Population Responses to Habitat Changes

#' @title American shad habitat
#'
#' @description A dataset containing the surface area of American 
#' shad habitat segments by feature (dam or outlet) in
#' Atlantic coast drainages of North America. 
#'
#' @format A data frame with 868 observations of 22 variables:
#' \describe{
#' 
#' \code{TERMCODE}{ code used to identify regional, state, or river units in which features are located, assists with subselecting features for analysis.}
#' 
#' \code{system}{ name or name(s) of rivers included in catchment.}
#' 
#' \code{region}{ life-history region within which river is located (NI = northern iteroparous, SI = southern iteroparous, SP = semelparous)}
#' 
#' \code{huc_code}{ n-digit huc code for the huc identifier used in \code{TERMCODE}.}
#' 
#' \code{huc_level}{ watershed level used to determine \code{huc_code}.}
#' 
#' \code{count}{ number of habitat segments (features) included within \code{system}.}
#' 
#' \code{total}{ total historical habitat available in \code{system} (sq km).}
#' 
#' \code{UNIQUE_ID}{ unique value given to each dam and outlet feature.}
#' 
#' \code{type}{ type of feature, either \code{dam} or \code{outlet}.}
#' 
#' \code{catchmentID}{ unique value of the coastal outlet in which the dam is located upstream.}
#'
#' \code{habitat_sqkm}{ total habitat upstream, given in square kilometers of river area.}
#'
#' \code{habitatSegment_sqkm}{ amount of habitat in the segment upstream of the feature, between the feature and the next group of adjacent upstream features.}
#'
#' \code{functional_habitatSegment_sqkm}{ the value of \code{habitatSegment_sqkm} multiplied by the compounded passage fraction from outlet up to the feature.}
#'
#' \code{PassageToHabitat}{ passage fraction at feature, compounded over this and all downstream features. Default dam passage is zero, default outlet passage is one. These values can be modified at start of model run.}
#'
#' \code{terminal_name_huc10}{ name of HUC10 watershed of feature's outlet.}
#'
#' \code{terminal_name_huc8}{ name of HUC8 watershed of feature's outlet.}
#'
#' \code{terminal_name_huc6}{ name of HUC6 watershed of feature's outlet.}
#'
#' \code{terminal_name_huc4}{ name of HUC4 watershed of feature's outlet.}
#'
#' \code{dam_name}{ name of dam feature, "n/a" if \code{outlet}.}
#'
#' \code{latitude}{ Latitudinal coordinate of feature centroid.}
#' 
#' \code{longitude}{ Longitudinal coordinate of feature centroid.}
#'
#' \code{dam_order}{ order in which dam is located in river, starting from coastal outlet. Outlets have code = 0.}
#' }
#' 
#' @source Samuel G. Roy: \url{https://github.com/samGroy/AmShadProject}
#' 
#' @references Zydlewski, J., D. S. Stich, S. Roy, M. Bailey, T. Sheehan, and
#' K. Sprankle. 2021. What Have We Lost? Modeling Dam Impacts on American Shad 
#' Populations Through Their Native Range. Frontiers in Marine Science 8.
#' DOI: https://doi.org/10.3389/fmars.2021.734213. 
#' 
"habitat"