README.Rmd

---
output: github_document
---

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

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# rforcpue

<!-- badges: start -->
<!-- badges: end -->

__rforcpue__ is designed to assist with the standardization of fisheries cpue data and the intent is that it will replace the __cede__ and __r4cpue__ packages, which are now deprecated and will become obsolete. As a package, __rforcpue__ is tied to no particular fishery or species and attempts are made to make the functions customizable to suit any given species or fishery. Functions will be developed that will enable the use of simple linear models (with log-transformed cpue data), use of GLMs (with different underlying distributions), and GAMs, along with examples of each. We will use a _News.md_ file to track developments in this package as they occur.

This package is currently under development and has no vignettes, as yet. There are many additional functions I intend to add that implement and illustrate GLMs with alternative residual distributions and GAMs, should they be wanted. It imports __rutilsMH__, so that package will also be needed should you wish to use this.  

## Installation

You can install this development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("haddonm/rforcpue")
```
## Example

This will need to wait until I have some exampe data built in.

```{r example}
library(rforcpue)
## basic example code
```