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%"
)
```
# rivRmon <img src="man/figures/rivRmon_logo.png" align="right" style="padding-left:10px;background-color:white;" />

<!-- badges: start -->
[![Project Status: Unsupported – The project has reached a stable, usable state but the author(s) have ceased all work on it. A new maintainer may be desired.](https://www.repostatus.org/badges/latest/unsupported.svg)](https://www.repostatus.org/#unsupported)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![GitHub issues](https://img.shields.io/github/issues/dbca-wa/rivRmon.svg?style=popout)](https://github.com/dbca-wa/rivRmon/issues/)
[![Last-changedate](https://img.shields.io/github/last-commit/dbca-wa/rivRmon.svg)](https://github.com/dbca-wa/rivRmon/commits/master)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/dbca-wa/rivRmon?branch=master&svg=true)](https://ci.appveyor.com/project/dbca-wa/rivRmon)
[![Github top language](https://img.shields.io/github/languages/top/dbca-wa/rivRmon.svg)](https://github.com/dbca-wa/rivRmon/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14166500.svg)](https://doi.org/10.5281/zenodo.14166500)
<!-- badges: end -->

The goal of rivRmon is to provide tools to aid in data munging and visualisation of monitoring data from the Swan and Canning Rivers.

## Installation

You can install the development version from [GitHub](https://github.com/dbca-wa) with:

``` r
# install.packages("devtools")
devtools::install_github("dbca-wa/rivRmon")
library(rivRmon)
```
## Help Files

All functions within rivRmon have the usual R help files, however the best place to see these and some vignettes is the [rivRmon website](https://dbca-wa.github.io/rivRmon/index.html)