potential_univariate: Potential Analysis for Univariate Data

Description Usage Arguments Value Author(s) References Examples

View source: R/potential_analysis.R

Description

One-dimensional potential estimation for univariate timeseries.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
potential_univariate(
  x,
  std = 1,
  bw = "nrd",
  weights = c(),
  grid.size = NULL,
  peak.threshold = 1,
  bw.adjust = 1,
  density.smoothing = 0,
  min.density = 1
)

Arguments

x

Univariate data (vector) for which the potentials shall be estimated

std

Standard deviation of the noise (defaults to 1; this will set scaled potentials)

bw

kernel bandwidth estimation method

weights

optional weights in ksdensity (used by potential_slidingaverages).

grid.size

Grid size for potential estimation. of density kernel height dnorm(0, sd=bandwidth)/N

peak.threshold

Mode detection threshold

bw.adjust

The real bandwidth will be bw.adjust*bw; defaults to 1

density.smoothing

Add a small constant density across the whole observation range to regularize density estimation (and to avoid zero probabilities within the observation range). This parameter adds uniform density across the observation range, scaled by density.smoothing.

min.density

minimum accepted density for a maximum; as a multiple of kernel height

Value

potential_univariate returns a list with the following elements:

Author(s)

Based on Matlab code from Egbert van Nes modified by Leo Lahti. Extended from the initial version in the earlywarnings R package.

References

Examples

1
# res <- potential_univariate(x)

microbiome documentation built on Nov. 8, 2020, 5:08 p.m.