summary {anomaly}R Documentation

Summary of collective and point anomalies.

Description

Summary methods for S4 objects returned by capa, capa.uv, capa.mv, pass, and sampler. The output displayed depends on the type of object passed to summary. For all types, the output indicates whether the data is univariate or multivariate, the number of observations in the data, and the type of change being detected.

For an object produced by capa.uv or capa.mv, pass, or sampler, summary displays a summary of the analysis.

For an object produced by capa is the same as for an object produced by capa.uv or capa.mv.

Usage

## S4 method for signature 'bard.sampler.class'
summary(object, ...)

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

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

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

## S4 method for signature 'pass.class'
summary(object, ...)

Arguments

object

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

...

Ignored.

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.

See Also

capa,capa.uv,capa.mv,pass,sampler.


[Package anomaly version 4.0.1 Index]