Skip to content

Commit

Permalink
Minor updates to documentation (close #122)
Browse files Browse the repository at this point in the history
  • Loading branch information
brews committed Jan 8, 2019
1 parent 8ff9a86 commit 4e214b2
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# burnr v0.3.1.9000

Changes in this patch release:

* Updates to documentation and README.


# burnr v0.3.0

Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
[![Research software impact](http://depsy.org/api/package/cran/burnr/badge.svg)](http://depsy.org/package/r/burnr)



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


## A quick example

```R
Expand All @@ -31,6 +31,7 @@ Cool, eh?

See `help(plot_demograph)` for more plot options. You can read and write your own FHX files with `read_fhx()` and `write_fhx()`.


## Installation

You can install a relatively stable version of this package from CRAN by opening an R session and running:
Expand All @@ -47,7 +48,7 @@ devtools::install_github("ltrr-arizona-edu/burnr")

## Support

Documentation is included in the code. If you're new to `burnr`, we have an [introduction](https://cran.r-project.org/package=burnr/vignettes/introduction.html). And more information can be found on the [project's wiki](https://github.com/ltrr-arizona-edu/burnr/wiki). Note, this is still under construction.
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 have also an [introduction](https://cran.r-project.org/package=burnr/vignettes/introduction.html). More information can be found on the [project's wiki](https://github.com/ltrr-arizona-edu/burnr/wiki). Note, this is still under construction.


## Citation
Expand All @@ -67,3 +68,5 @@ Citations help us to identify user needs and justify additional time developing
Want to contribute? Great! We're following [Hadley's packaging workflow](http://r-pkgs.had.co.nz/) and [code style](http://adv-r.had.co.nz/Style.html). Fork away.

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

If you're not a developer, don't worry! We also welcome help with documentation and tutorials.
6 changes: 2 additions & 4 deletions vignettes/introduction.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,13 @@ vignette: >
\usepackage[utf8]{inputenc}
---

# Introduction

This is a brief tutorial to cover some general ideas and help you get started with some basic features in burnr. This is a simple tutorial so you won't need crazy coding skills. I am going to assume that you have a [recent version of R](https://www.r-project.org) installed and are familiar with the basics of R.
This is a brief tutorial to cover some general ideas and basic features in burnr. This is a simple tutorial so you won't need crazy coding skills. I am going to assume that you have a [recent version of R](https://www.r-project.org) installed and are familiar with the basics of R.

If you are not familiar with R, hit Google with the search "R stat tutorial", or some variation there of. You will find a plethora of useful learning material and helpful people from a wide array of backgrounds.

People pickup this coding stuff more quickly if they try the examples I give and play around with the interesting things they discover. I recommend you open a terminal with an R session and follow along as you read this. It's more fun that way.

## What's burnr
## What's burnr?

burnr is a package for forest fire history analysis in the R statistical environment. This package isn't designed to be a comprehensive suite for fire analysis. Rather the idea is to provide a transparent, flexible, and powerful set of core tools.

Expand Down

0 comments on commit 4e214b2

Please sign in to comment.