burnr (version 0.6.1)

composite: Composite fire events in fhx object

Description

Composite fire events in fhx object

Usage

composite(
  x,
  filter_prop = 0.25,
  filter_min_rec = 2,
  filter_min_events = 1,
  injury_event = FALSE,
  comp_name = "COMP"
)

Arguments

x

An fhx object.

filter_prop

The minimum proportion of fire events in recording series needed for fire event to be considered for composite. Default is 0.25.

filter_min_rec

The minimum number of recording series needed for a fire event to be considered for the composite. Default is 2 recording series.

filter_min_events

The minimum number of fire scars needed for a fire event to be considered for the composite. Default is 1. Fire injuries are included in this count if injury_event is TRUE.

injury_event

Boolean indicating whether injuries should be considered events. Default is FALSE.

comp_name

Character vector of the series name for the returned fhx object composite series. Default is 'COMP'.

Value

An fhx object representing the composited series. The object will be empty if there are nocomposite-worthy events.

See Also

• intervals() fire interval analysis from an fhx composite.

• sea() superposed epoch analysis.

• series_stats() basic summary stats for an fhx object.

• get_event_years() gets years for various events in an fhx object.

• count_event_position() count the number of different events in an fhx object.

• yearly_recording() count the number of "recording" events in each year of an fhx object.

• fhx() constructs an fhx object.

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

Examples

# NOT RUN {
data(lgr2)
plot(composite(lgr2))

# Use with composite to get composite years:
comp <- composite(pgm, comp_name = "pgm")
event_yrs <- get_event_years(comp)[["pgm"]]
print(event_yrs)

# }