Learn R Programming
burnr (version 0.2.0)

site_stats: Generate site-level summary statistics

Description

Generate site-level summary statistics

Usage

site_stats(x, site_name = "XXX", year_range = NULL, filter_prop = 0.25,
  filter_min_rec = 2, filter_min_events = 1, injury_event = FALSE)

Arguments

x
An fhx object
site_name
Three character site code, defaults to "XXX"
year_range
Delimits the analysis period. For example, c(1600, 1900).
filter_prop
An optional argument if the user chooses to include a composite rug in their plot. This is passed to composite. See this function for details.
filter_min_rec
An optional argument if the user chooses to include a composite rug in their plot. This is passed to composite. See this function for details.
filter_min_events
An optional argument if the user chooses to include a composite rug in their plot. This is passed to composite. See this function for details.
injury_event
Boolean indicating whether injuries should be considered recorders. This is passed to composite. See this function for details.

Value

A data.frame of summary statistics

Details

This function produces a summary table for any fhx object. The statistics it includes are shared by other popular fire history software such as FHX2 and FHAES.