README.Rmd

---
output: github_document
---

```{r echo=FALSE}
knitr::opts_chunk$set(
  warning = FALSE,
  message = FALSE,
  collapse = TRUE,
  comment = "#>"
)
```

# gfplot: An R package for data extraction and plotting of British Columbia groundfish data

<!-- badges: start -->
[![R-CMD-check](https://github.com/pbs-assess/gfplot/workflows/R-CMD-check/badge.svg)](https://github.com/pbs-assess/gfplot/actions)
<!-- badges: end -->

Facilitates the creation of an annual groundfish data synopsis report with [gfsynopsis](https://github.com/pbs-assess/gfsynopsis).

Note that the documentation is incomplete in some places. Please post in the [issue tracker](https://github.com/pbs-assess/gfplot/issues) if you have questions or suggestions on how the package or its documentation could be improved.

In addition to the help available through the R console, a [web version of the documentation is available](https://pbs-assess.github.io/gfplot/index.html).

# Installation

The gfplot package can then be installed and loaded with:

```{r, eval=FALSE}
# install.packages("remotes")
remotes::install_github("pbs-assess/gfplot")
```

```{r}
library(gfplot)
```

Functions specific to PBS (now in gfdata):

```{r}
library(gfdata)
fns <- ls("package:gfdata")
sort(fns[grepl("get", fns)])
```

Generic functions for any similarly formatted data:

```{r}
fns <- ls("package:gfplot")
sort(fns[grepl("tidy", fns)])
```

```{r}
sort(fns[grepl("fit", fns)])
```

```{r}
sort(fns[grepl("plot", fns)])
```