Package containing functions and data for American shad population modeling
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
data
inst/examples
man
src
.Rbuildignore
.gitignore
DESCRIPTION
LICENSE
NAMESPACE
README.md

README.md

shadia

Package containing functions and data for American shad population modeling.

Note

This package is under constant, rapid development as it is part of ongoing research. Therefore, there is not currently a stable version of the package. Please check regularly for updates, changes, and bug patches.


Installation

This package can be installed with the devtools package in R using the repository url:

devtools::install_github("danStich/shadia")

To install shadia, you will need to have devtools installed ahead of time in R, but that requires some special tools. To install on Windows, you will need to download and install the appropriate version of Rtools. To install on Mac, you will need to have the XCode command-line tools installed. And, if running from Linux, you will need to install the developer version of R (r-base-dev) if you have not already.


Use

The purpose of this package is to distribute code used to run the American shad dam passage performance standard model. Currently, the model is implemented for the Penobscot, Merrimack, Connecticut, and Susquehanna rivers, USA, but we are actively adding new rivers. The main package functions, connecticutRiverModel(), merrimackRiverModel(), penobscotRiverModel(), and susquehannaRiverModel() can be run without any arguments to estimate population abundance in various reaches or in whole rivers under 'no dam' passage scenarios. Alternatively, the user can pass one or more values for upstream and downstream fish passage at a given dam which can then be applied throughout the watershed, or separately at each dam. Outputs include population abundance of spawners in the watersheds, within specific production units of each river, and the proportion of repeat spawners in each age class.

The models take several (10-30) seconds to run for one iteration on most standard workstations.


Warning

Management decisions should not be based on a single model run. The models rely on stochastic inputs for parameterization, as detailed in Stich et al. (2018). As such, any two model runs might result in substantially different predictions, even under the same passage scenario. We recommend at least 100 model runs per scenario to provide a minimal characterization of stochasticity, and a cursory understanding of variability in the response(s) of interest. In these cases, we strongly recommend running the model using the snowfall package as demonstrated in the help file for each model, which can be accessed by typing ?...RiverModel (where '...' is the name of each river in lowercase) in the console and pressing < Enter >.

Directories

data/

  • Contains built-in data sets for the package

man/

  • help files and documentation

R/

  • R functions in scripts

src/

  • C++ source files written with Rcpp