Function reference • burnr

Import and export data Read/write FHX file formats. These are specialized text files for storing tree-ring fire history data. FHX files can be created in FHAES, or by our specialized MS Access Database.
`read_fhx()`	Read FHX2 file and return an `fhx`` object
`write_fhx()`	Write an `fhx` object to a new FHX2 file
Included data
`pgm`	Peggy Mesa fire-history data
`pgm_meta`	Metadata for the Peggy Mesa fire-history dataset
`pgm_pdsi`	Reconstructed PDSI time series for the Peggy Mesa fire-history dataset
`lgr2`	Los Griegos Peak plot2 fire-history data
`lgr2_meta`	Metadata for the Los Griegos Peak fire-history dataset
`pme`	Pajarito Mountain East fire-history data
`pmw`	Pajarito Mountain West fire-history data
`pmr`	Pajarito Mountain Ridge fire-history data
Data manipulation
`+`(<fhx>)	Concatenate or combine two fhx objects
`sort(<fhx>)`	Sort the series names of `fhx` object by the earliest or latest year
`composite()`	Composite fire events in fhx object
`delete()`	Remove series or years from an `fhx` object
`get_series()`	Extract `fhx` observations for given series
`get_year()`	Extract `fhx` observations for given years
`is_fhx()`	Check if object is `fhx`.
`make_rec_type()`	Turn character vector into factor with proper `fhx` levels
`outer_type()`	Type of observation in the last (most recent) year of an `fhx` object
`last_year()`	Last (most recent) year of an `fhx` object
Graphics
`plot_demograph()`	Create an ggplot2 object for plotting fhx demographics
`plot(<fhx>)`	Plot an `fhx` object
`plot(<intervals>)`	Plot a fire `intervals` object
`plot(<sea>)`	Plot a `sea` object
`plot_intervals_dist()`	Basic fire `intervals` distribution plot
Statistical summaries
`series_stats()`	Generate series-level descriptive statistics for `fhx` object
`intervals()`	Calculate fire intervals from a `composite`
`count_event_position()`	Count different events in an `fhx` object
`count_scar()`	Number of scar events in an `fhx` object
`count_injury()`	Number of injury events in an `fhx` object
`count_recording()`	Number of recording years in an `fhx` object
`count_year_span()`	Number of years of an `fhx` object
`get_event_years()`	Get years with events for an `fhx` object
Derrived time series
`percent_scarred()`	Percent scarred time series for `fhx` object
`sample_depth()`	Calculate the sample depth of an `fhx` object
Fire-climate relationship
`sea()`	Perform superposed epoch analysis
MISC
`as.fhx()`	Alias to `as_fhx()`
`as_fhx()`	Cast data frame or list-like to `fhx` object
`fhx()`	Constructor for `fhx` objects
`first_year()`	First (earliest) year of an `fhx` object
`inner_type()`	Type of observation in the first (earliest) year of an `fhx` object
`is.fhx()`	Alias to `is_fhx()`
`is.intervals()`	Alias to `is_intervals()`
`is.sea()`	Alias to `is_sea()`
`is_fhx()`	Check if object is `fhx`.
`is_intervals()`	Check if object is fire `intervals`
`is_sea()`	Check if object is `sea`
`max(<intervals>)`	Maximum interval in fire `intervals`
`mean(<intervals>)`	Fire `intervals` arithmetic mean
`median(<intervals>)`	Fire `intervals` median
`min(<intervals>)`	Minimum interval in fire `intervals`
`plot_sealags()`	Basic SEA lag plot of `sea` object
`print(<intervals>)`	Print a fire `intervals` object
`print(<sea>)`	Print a `sea` object.
`quantile(<intervals>)`	Fit distribution quantiles to fire `intervals`
`series_mean_interval()`	Calculate quick mean fire interval of an `fhx` object with single series
`series_names()`	Get `fhx` series names
`summary(<fhx>)`	Summary of `fhx` object
`yearly_recording()`	Count the number of recording series for each year in an `fhx` object
`year_range()`	Range of years in an `fhx` object

Reference

Import and export data

Included data

Data manipulation

Graphics

Statistical summaries

Derrived time series

Fire-climate relationship

MISC