burnr (version 0.6.1)

series_stats: Generate series-level descriptive statistics for fhx object

Description

Generate series-level descriptive statistics for fhx object

Usage

series_stats(
  x,
  func_list = list(first = first_year, last = last_year, years = count_year_span,
    inner_type = inner_type, outer_type = outer_type, number_scars = count_scar,
    number_injuries = count_injury, recording_years = count_recording, mean_interval =
    series_mean_interval)
)

Arguments

x

An fhx object.

func_list

A list of named functions that will be run on each series in the fhx object. The list name for each function is the corresponding column name in the output data frame.

Value

A data.frame containing series-level statistics.

See Also

• fhx() creates an fhx object.

• as_fhx() casts data frame into an fhx object.

• first_year() gets earliest year in an fhx object.

• last_year() gets latest year in an fhx object.

• count_year_span() counts the year span of an fhx object.

• inner_type() gets "rec_type" for inner event of an fhx object.

• outer_type() get "rec_type" for outside event of an fhx object.

• count_scar() counts scars in an fhx object.

• count_injury() counts injuries in an fhx object.

• count_recording() counts recording years in fhx object.

• series_mean_interval() quickly estimates mean fire-interval of fhx object.

• sample_depth() gets sample depth of an fhx object.

• summary.fhx() brief summary of an fhx object.

• composite() create a fire composite from an fhx object.

• intervals() get fire intervals analysis from composite.

• sea() superposed epoch analysis.

Examples

# NOT RUN {
data(lgr2)
series_stats(lgr2)

# You can create your own list of statistics to output. You can also create
# your own functions:
flist <- list(
  n = count_year_span,
  xbar_interval = function(x) mean_interval(x, injury_event = TRUE)
)
sstats <- series_stats(lgr2)
head(sstats)
# }