seg_basket: Default class for candidate changepoint sets

View source: R/class-seg_basket.R

new_seg_basketR Documentation

Default class for candidate changepoint sets

Description

Default class for candidate changepoint sets

Usage

new_seg_basket(
  x = numeric(),
  algorithm = NA,
  cpt_list = list(),
  seg_params = list(),
  model_name = "meanshift_norm",
  penalty = "BIC",
  ...
)

seg_basket(x, ...)

Arguments

x

a numeric vector coercible into a stats::ts() object

algorithm

Algorithm used to find the changepoints

cpt_list

a possibly empty list() of candidate changepoints

seg_params

a possibly empty list() of segmenter parameters

model_name

character indicating the model used to find the changepoints.

penalty

character indicating the name of the penalty function used to find the changepoints.

...

currently ignored

Value

A seg_basket() object.

Examples

seg <- seg_basket(DataCPSim, cpt_list = list(c(365), c(330, 839)))
str(seg)
as.ts(seg)
changepoints(seg)
fitness(seg)

tidychangepoint documentation built on April 4, 2025, 4:31 a.m.