events_from_ts: Extract events from a time series.

In ts2net: From Time Series to Networks

Extract events from a time series.

Description

This function transforms an time series (array) into a binary time series where 1 means a event and 0 means no event.

Usage

events_from_ts(
  ts,
  th,
  method = c("greater_than", "lower_than", "top_percentile", "lower_percentile",
    "highest", "lowest"),
  return_marked_times = FALSE
)

Arguments

ts	Array. Time series
th	A threshold (if 'method=greater_than' or '=lower_than'), or the percentile (if 'method=top_percentile' or '=lower_percentile'), or the total number (if 'method=highest' or '=lowest').
method	String. One of following options: * 'greater_than': All values greater or equal to 'th'. * 'lower_than': All values lower or equal to 'th'. * 'top_percentile': Values greater than the 'th' percentile. * 'highest': The top 'th' values. * 'lowest': The lower 'th' values.
return_marked_times	Return the time indices (marked points) where the events occur.

Value

An event (binary, 1: event, 0 otherwise) time series

ts2net documentation built on June 9, 2022, 9:06 a.m.