burnr (version 0.6.1)

get_event_years: Get years with events for an fhx object

Description

Get years with events for an fhx object

Usage

get_event_years(
  x,
  scar_event = TRUE,
  injury_event = FALSE,
  custom_grep_str = NULL
)

Arguments

x

An fhx object.

scar_event

Boolean indicating whether years with scar events should be returned. Default is TRUE.

injury_event

Boolean indicating whether years with injury events should be returned. Default is FALSE.

custom_grep_str

Character string to pass a custom grep search pattern to search x "rec_type" column for. NULL by default.

Value

A list. Elements of the list are numeric vectors giving the years with events for each fhx series. Each element's name reflects the series' name.

See Also

• series_names() get all the series in an fhx object.

• year_range() get earliest and latest year in an fhx object.

• get_year() subset an fhx object to select years.

• get_series() subset an fhx object to select series.

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

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

Examples

# NOT RUN {
data(pgm)
get_event_years(pgm, scar_event = TRUE, injury_event = TRUE)

# Passing a custom string to grep. This one identified recorder years:
get_event_years(pgm, custom_grep_str = "recorder_")

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

# }