BinSeg-class: An S4 class that represents a set of changepoint models.

In diego-urgell/BinSeg: Efficient Binary Segmentation for several distributions

Description

An S4 class that represents a set of changepoint models.

Slots

data

A numeric vector with the data used to perform the changepoint analysis.

models_summary

A data.table with the summary of the segmentation models. It is only intended for internal usage. It is recommended to use the other functions to interact with the changepoint model and obtain parameter estimations.

algorithm

The algorithm string selected for the changepoint analysis.

distribution

The distribution string selected for the changepoint analysis.

min_seg_len

The value selected as the minimum segment length (default is 1).

param_names

The parameters that will be estimated by the changepoint model according to the selected distribution.

Warning

You should not create BinSeg objects by hand. You must provide the data to the BinSegModel function, which will compute the changepoint model by using the Rcpp interface and then fix the output to create a BinSeg object and return it.

See Also

BinSegModel for computing the changepoint model and obtaining a BinSeg object.

diego-urgell/BinSeg documentation built on Dec. 19, 2021, 11:11 p.m.