fhx {burnr}

Constructor for fhx objects

Description

Constructor for fhx objects

Usage

fhx(year, series, rec_type)

Arguments

year

An n-length numeric vector of observation years.

series

An n-length factor or character vector of observation series names.

rec_type

An n-length factor or character vector denoting the record type for each observations. Note that this needs to use a controlled vocabulary, see burnr:::rec_type_all for all possible values.

Details

Note that 'year', 'series', and 'rec_type' are pass through as.numeric(), as.factor(), and make_rec_type() the fhx object is created.

Value

An fhx object. fhx are S3 objects; specialized data frames with 3 columns:

• "year": An n-length numeric vector. The year of an observation.

• "series": An n-length factor. Giving the series name for each observation.

• "rec_type": An n-length factor with controlled vocabulary and levels. This records the type of ring or record of each observation.

See Also

• as_fhx() casts data frame-like object into fhx object.

• sort.fhx() sort an fhx object.

• is_fhx() test whether object is fhx.

• +.fhx() concatenate multiple fhx objects together.

• make_rec_type() helpful to convert rec_type-like character vectors to full facors with proper levels.

• read_fhx() Read FHX2 files.

• write_fhx() Write FHX2 files.

• plot_demograph() makes demography plots of fhx objects.

• series_stats() basic common statistical summaries of fhx objects.

• composite() create fire composites from fhx objects.

• intervals() fire interval analysis.

• sea() superposed epoch analysis.

Examples

x <- fhx(
  year = c(1900, 1954, 1996),
  series = rep("tree1", 3),
  rec_type = c("pith_year", "unknown_fs", "bark_year")
)
print(x)