streaklog: Utility functions for slicing gappy time series

In adamkocsis/divDyn: Diversity Dynamics using Fossil Sampling Data

Utility functions for slicing gappy time series

Description

The function returns where the continuous streaks start and how long they are, which can be used for efficient and flexible subsetting.

Usage

streaklog(x)

whichmaxstreak(x, which = -1)

Arguments

x	(vector) A vector with missing values.
which	(integer) In case multiple streaks of the same length are found, which of them should be returned by the vector (integer).

Details

The output list of streaklog contains the following elements:

starts: the indices where the streaks start.

streaks: the lengths of the individual streaks (number of values).

runs: the number of streaks.

The function whichmaxstreak() will return the indices of those values that are in the longest continuous streak.

Value

A list (streaklog) or a numeric vector (whichmaxstreak).

Examples

# generate a sequence of values
  b<-40:1
# add some gaps
  b[c(1:4, 15, 19, 23:27)]  <- NA
# the functions
  streaklog(b)
  whichmaxstreak(b)

adamkocsis/divDyn documentation built on Nov. 23, 2024, 4:41 a.m.