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

## FireHistory <img src='man/figures/FireHistory.png' align="right" height="250" />

<!-- badges: start -->
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![GitHub issues](https://img.shields.io/github/issues/dbca-wa/FireHistory.svg?style=popout)](https://github.com/dbca-wa/FireHistory/issues/)
[![Last-changedate](https://img.shields.io/github/last-commit/dbca-wa/FireHistory.svg)](https://github.com/dbca-wa/FireHistory/commits/master)
[![Github top language](https://img.shields.io/github/languages/top/dbca-wa/FireHistory.svg)](https://github.com/dbca-wa/FireHistory/)
[![R-CMD-check](https://github.com/dbca-wa/dbca-wa/FireHistory/R-CMD-check/badge.svg)](https://github.com/dbca-wa/FireHistory/actions)
[![DOI](https://zenodo.org/badge/529086399.svg)](https://zenodo.org/badge/latestdoi/529086399)
[![Codecov test coverage](https://codecov.io/gh/Bartesto/FireHistory/branch/master/graph/badge.svg)](https://app.codecov.io/gh/Bartesto/FireHistory?branch=master)
<!-- badges: end -->

The goal of FireHistory is to provide tools to help extract useful fire metrics 
from the Department of Biodiversity, Conservation and Attractions Fire History 
dataset [data WA link](https://catalogue.data.wa.gov.au/dataset/dbca-fire-history).

## Installation

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

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

## Help Files

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