-
Notifications
You must be signed in to change notification settings - Fork 8
/
README.Rmd
84 lines (53 loc) · 3.13 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
---
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%"
)
```
# burnr
<!-- badges: start -->
[](https://cran.r-project.org/package=burnr)
[](https://coveralls.io/github/ltrr-arizona-edu/burnr?branch=master)
[](https://github.com/ltrr-arizona-edu/burnr/actions)
[](https://cran.r-project.org/package=burnr)
[](https://doi.org/10.5281/zenodo.594459)
<!-- badges: end -->
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, <https://ltrr-arizona-edu.github.io/burnr/>. And you can work through examples, with included data, in an R project hosted by @chguiterman on GitHub: <https://github.com/chguiterman/burnr_demo>. 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.