tidycpt-class {tidychangepoint} | R Documentation |
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. Useas.segmenter()
to retrieve them. -
model
: A model object inheriting from mod_cpt, as created byas.model()
when called on thesegmenter
. -
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)
[Package tidychangepoint version 1.0.1 Index]