timeSeriesSummary: Time series summary

View source: R/pitchDescriptives.R

timeSeriesSummaryR Documentation

Time series summary

Description

Internal soundgen function

Usage

timeSeriesSummary(
  x,
  step,
  inflThres = NULL,
  extraSummaryFun = c(),
  ref = 16.35,
  plot = FALSE,
  main = ""
)

Arguments

x

numeric vector

step

time step in s

inflThres

minimum difference (in semitones) between consecutive extrema to consider them inflections; to apply a different threshold at each smoothing level, provide inflThres as a vector of the same length as smoothBW; NA = no threshold

extraSummaryFun

additional summary function(s) that take a numeric vector with some NAs and return a single number, eg c('myFun1', 'myFun2')

ref

reference value for transforming Hz to semitones, defaults to C0 (16.35 Hz)

plot

if TRUE, plots the inflections for manual verification

Details

A helper function called by .pitchDescriptives for each smoothing level.


soundgen documentation built on Aug. 14, 2022, 5:05 p.m.