https://github.com/ltrr-arizona-edu/burnr

🔥 Forest fire history analysis in R.
https://github.com/ltrr-arizona-edu/burnr

citation cran dendrochronology ecology forestfire plot r scientific statistics

Last synced: about 2 months ago
JSON representation

🔥 Forest fire history analysis in R.

• Host: GitHub
• URL: https://github.com/ltrr-arizona-edu/burnr
• Owner: ltrr-arizona-edu
• Created: 2012-08-03T22:12:47.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2022-05-20T23:12:37.000Z (over 2 years ago)
• Last Synced: 2024-03-23T22:39:51.308Z (9 months ago)
• Topics: citation, cran, dendrochronology, ecology, forestfire, plot, r, scientific, statistics
• Language: R
• Homepage: https://ltrr-arizona-edu.github.io/burnr/
• Size: 7.13 MB
• Stars: 15
• Watchers: 9
• Forks: 8
• Open Issues: 16
• Metadata Files:
  • Readme: README.Rmd

Awesome Lists containing this project

• open-sustainable-technology - burnr - Basic tools to analyze forest fire history data (e.g. FHX) in R. (Biosphere / Wildfire)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# burnr

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/burnr)](https://cran.r-project.org/package=burnr)

[![Coverage Status](https://coveralls.io/repos/github/ltrr-arizona-edu/burnr/badge.svg?branch=master)](https://coveralls.io/github/ltrr-arizona-edu/burnr?branch=master)

[![R-CMD-check](https://github.com/ltrr-arizona-edu/burnr/workflows/R-CMD-check/badge.svg)](https://github.com/ltrr-arizona-edu/burnr/actions)

[![downloads](https://cranlogs.r-pkg.org/badges/burnr)](https://cran.r-project.org/package=burnr)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.594459.svg)](https://doi.org/10.5281/zenodo.594459)

Basic tools to analyze forest fire history data (e.g. FHX) in R. This is designed for power users and projects with special needs.

## Installation

You can install the released version of burnr from [CRAN](https://CRAN.R-project.org) with:

``` r

install.packages("burnr")

```

And the development version from [GitHub](https://github.com/) with:

``` r

# install.packages("devtools")

devtools::install_github("ltrr-arizona-edu/burnr")

```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}

library(burnr)

# This gives you a basic plot. There are more advanced options. For example, we can color our plot by sample species.

data(lgr2_meta)

plot(lgr2,

  color_group = lgr2_meta$SpeciesID,

  color_id = lgr2_meta$TreeID,

  plot_legend = TRUE

)

```

## Support

Documentation is included in the code. If you're new to `burnr`, our [2018 paper in Dendrochronologia](https://doi.org/10.1016/j.dendro.2018.02.005) is a nice survey of the package with many examples. We also have instructional vignettes on the project website, . And you can work through examples, with included data, in an R project hosted by @chguiterman on GitHub: . We're working to enhance our instruction and add to these demos on the burnr website, so please send us requests for new tips and tricks, or create your own and share with us!

## Citation

Please cite the original `burnr` paper if you use it in your research: 

> Malevich, Steven B., Christopher H. Guiterman, and Ellis Q. Margolis (2018) [Burnr: Fire History Analysis and Graphics in R](https://www.sciencedirect.com/science/article/abs/pii/S1125786517301418?via%3Dihub). _Dendrochronologia_ 49: 9–15. DOI: 10.1016/j.dendro.2018.02.005.

Citations help us to identify user needs and justify additional time developing and maintaining `burnr`.

## Development

Please file bugs in the [bug tracker](https://github.com/ltrr-arizona-edu/burnr/issues).

Want to contribute? Great! We're following [Hadley's packaging workflow](https://r-pkgs.org/) and [style guide](https://style.tidyverse.org/). Fork away.

If you're not a developer, don't worry! We also welcome help with documentation and tutorials.