fhx: Constructor for 'fhx' objects

Description Usage Arguments Details Value See Also Examples

View source: R/utils.R

Description

Constructor for fhx objects

Usage

1
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:

See Also

Examples

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

burnr documentation built on March 10, 2021, 5:07 p.m.