point_anomalies {anomaly}R Documentation

Point anomaly location and strength.

Description

Creates a data frame containing point anomaly locations and strengths as detected by capa, capa.uv, capa.mv, scapa.uv, and scapa.mv.

For an object produced by capa.uv or scapa.uv, the output is a data frame with columns containing the position and strength of the anomaly.

For an object produced by capa.mv or capa.mv, point_anomalies returns a data frame with columns containing the position, variate, and strength of the anomaly.

For an object produced by capa, point_anomalies returns the same results as scapa.uv when the data is univariate, and the same results as scapa.mv when the data is multivariate.

Usage

## S4 method for signature 'capa.class'
point_anomalies(object, epoch = nrow(object@data))

## S4 method for signature 'capa.mv.class'
point_anomalies(object)

## S4 method for signature 'capa.uv.class'
point_anomalies(object)

## S4 method for signature 'scapa.mv.class'
point_anomalies(object, epoch = nrow(object@data))

## S4 method for signature 'scapa.uv.class'
point_anomalies(object, epoch = nrow(object@data))

Arguments

object

An instance of an S4 class produced by capa, capa.uv, and capa.mv.

epoch

Positive integer. CAPA methods are sequential and as such, can generate results up to, and including, any epoch within the data series. This can be controlled by the value of epoch and is useful for examining how the inferred anomalies are modified as the data series grows. The default value for epoch is the length of the data series.

Value

A data frame.

See Also

capa, capa.uv, capa.mv.


[Package anomaly version 4.0.1 Index]