tidycpt-class: Container class for 'tidycpt' objects

In tidychangepoint: A Tidy Framework for Changepoint Detection Analysis

Container class for tidycpt objects

Description

Container class for tidycpt objects

Details

Every tidycpt object contains:

• segmenter: The object returned by the underlying changepoint detection algorithm. These can be of arbitrary class. Use as.segmenter() to retrieve them.

• model: A model object inheriting from mod_cpt, as created by as.model() when called on the segmenter.

• elapsed_time: The clock time that passed while the algorithm was running.

• time_index: If available, the labels for the time indices of the time series.

Value

A tidycpt object.

Examples

# Segment a time series using PELT
x <- segment(CET, method = "pelt")
class(x)
str(x)

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