dm_event_times: Extract event times from phase.zg() or phase.sc() output

View source: R/dm_sea.R

dm_event_timesR Documentation

Extract event times from phase.zg() or phase.sc() output

Description

Extracts event times from objects returned by phase.zg() or phase.sc(). The resulting table can be passed directly to [dm_epoch_extract()] for superposed epoch analysis.

Usage

dm_event_times(
  x,
  event = "all",
  phase = NULL,
  min_duration = NULL,
  min_magnitude = NULL,
  min_max_twd = NULL,
  remove_na_times = TRUE
)

Arguments

x

Object of class "ZG_output" or "SC_output".

event

Event type to extract. Use "all" to return all supported events. For ZG output, supported events are "TWD_start", "TWD_end", "GRO_start", "GRO_end", "MaxTWD", "phase_start", and "phase_end". For SC output, supported events are "Shrinkage_start", "Shrinkage_end", "Expansion_start", "Expansion_end", "Increment_start", "Increment_end", "phase_start", and "phase_end".

phase

Optional phase filter for generic events "phase_start" or "phase_end". For ZG output, use "TWD" or "GRO". For SC output, use "Shrinkage", "Expansion", or "Increment".

min_duration

Optional minimum Duration_h filter.

min_magnitude

Optional minimum Magnitude filter.

min_max_twd

Optional minimum max.twd filter for ZG output.

remove_na_times

Logical. If TRUE, rows with missing event_time are removed.

Value

A tibble of events with class c("dm_events", ...).


dendRoAnalyst documentation built on May 20, 2026, 5:07 p.m.