
<!-- README.md is generated from README.Rmd. Please edit that file -->

## rFAMS <img src="man/figures/rFAMSLogo.png" align="right" height="150" width="150" alt="rFAMS logo" />

<!-- badges: start -->

<!-- badges: end -->

### Fisheries Analysis and Modeling Simulator in R

Simulates the dynamics of exploited fish populations using the Jones
modification of the Beverton-Holt equilibrium yield equation to compute
yield-per-recruit and dynamic pool models [(Ricker
1975)](https://publications.gc.ca/site/eng/480738/publication.html).
Allows users to evaluate minimum, slot, and inverted length limits on
exploited fisheries using specified life history parameters. Users can
simulate population under a variety of conditional fishing mortality and
conditional natural mortality. Calculated quantities include number of
fish harvested and dying naturally, mean weight and length of fish
harvested, number of fish that reach specified lengths of interest,
total number of fish and biomass in the population, and stock density
indices.

This package is maintained by [Jason Doll](mailto:jcdoll20@hotmail.com),
Associate Professor of Fisheries at Francis Marion University

Members of the [fishR Core Team](https://github.com/fishR-Core-Team)
that have contributed to the development of this package include:  
Jason Doll, Francis Marion University  
Derek Ogle, Northland College (retired)  
Maddie Lewis, Iowa Department of Natural Resources  
Hadley Boehm, Minnesota Department of Natural Resources

### Support

<!-- This project is supported in part by the [American Fisheries Society](https://fisheries.org) and the [Data and Technology Section](https://units.fisheries.org/fits) -->

This project is supported in part by the American Fisheries Society and
the Data and Technology Section.

### Status

The package currently replicates all yield per recruit and dynamic pool
modeling in FAMS with the exception of spawning potential ratio.
Spawning potential ratio calculations will be added at a later date.
Life history parameters can be estimated using [FSA
package](https://fishr-core-team.github.io/FSA/index.html)

#### Equilibrium Modeling

1.  Initial function completed
2.  Add spawning potential ratio
3.  Incorporate suggestions from the fisheries community.

#### Dynamic Pool Modeling

1.  Initial function completed
2.  Add spawning potential ratio
3.  Incorporate suggestions from the fisheries community.

#### RShiny Development

1.  Initial development completed
2.  Test with CRAN released rFAMS v0.0.2

### Installation

The [most recent stable
version](https://CRAN.R-project.org/package=rFAMS) from CRAN may be
installed with

``` r
install.packages("rFAMS")
```

The [development
version](https://github.com/fishR-Core-Team/rFAMS/tree/dev) may be
installed from GitHub with

``` r
# install.packages("devtools")
devtools::install_github("fishR-Core-Team/rFAMS@dev")
```

You may need R Tools installed on your system to install the development
version from GitHub. See the instructions for ([R Tools for
Windows](https://cran.r-project.org/bin/windows/Rtools/) or [R Tools for
Mac OS X](https://cran.r-project.org/bin/macosx/tools/)).

 

#### Questions / Comments / Problems or Contributions

Report questions, comments, or bug reports on the [issues
page](https://github.com/fishR-Core-Team/rFAMS/issues).

Please adhere to the [Code of
Conduct](https://fishr-core-team.github.io/rFAMS/CODE_OF_CONDUCT.html).

 

[![Project Status: Active - The project has reached a stable, usable
state and is being actively
developed.](http://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![CRAN
Version](http://www.r-pkg.org/badges/version/rFAMS)](https://www.r-pkg.org:443/pkg/rFAMS)
[![License](http://img.shields.io/badge/license-GPL%20%28%3E=%202%29-brightgreen.svg?style=flat)](http://www.gnu.org/licenses/gpl-2.0.html)
[![R-CMD-check](https://github.com/fishR-Core-Team/rFAMS/workflows/R-CMD-check/badge.svg)](https://github.com/fishR-Core-Team/rFAMS/actions)
[![CRAN RStudio mirror downloads
rate](http://cranlogs.r-pkg.org/badges/rFAMS) ![CRAN RSTudio mirror
downloads
total](http://cranlogs.r-pkg.org/badges/grand-total/rFAMS)](https://www.r-pkg.org:443/pkg/rFAMS)
