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%"
)
```

# groveR <img src="man/figures/tree_logo_small.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/groveR.svg?style=popout)](https://github.com/dbca-wa/groveR/issues/)
[![Last-changedate](https://img.shields.io/github/last-commit/dbca-wa/groveR.svg)](https://github.com/dbca-wa/groveR/commits/master)
[![Github top language](https://img.shields.io/github/languages/top/dbca-wa/groveR.svg)](https://github.com/dbca-wa/groveR/)
[![DOI](https://zenodo.org/badge/307265420.svg)](https://doi.org/10.5281/zenodo.14676717)
<!-- badges: end -->

The goal of `groveR` is to bring together a standard work flow that utilises satellite data to monitor mangroves. It focuses on taking annual satellite data through a number of processing steps to produce useful vegetation cover and change metrics.

## Installation

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

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

## Help Files

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