burnr (version 0.4.0)

composite: Composite fire events in fhx object returning composited object with prominent fires.

Description

Composite fire events in fhx object returning composited object with prominent fires.

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 instance.

filter_prop

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

filter_min_rec

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

filter_min_events

The minimum number of fire scars needed to be considered a fire event. Default is 1. This includes injuries if injury_event=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.

Examples

# NOT RUN {
data(lgr2)
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)

# }