as.segmenter: Convert, retrieve, or verify a segmenter object

In tidychangepoint: A Tidy Framework for Changepoint Detection Analysis

Convert, retrieve, or verify a segmenter object

Description

Convert, retrieve, or verify a segmenter object

Usage

as.segmenter(object, ...)

as.seg_cpt(object, ...)

## S3 method for class 'seg_basket'
as.seg_cpt(object, ...)

## S3 method for class 'seg_cpt'
as.seg_cpt(object, ...)

## S3 method for class 'tidycpt'
as.segmenter(object, ...)

## S3 method for class 'ga'
as.seg_cpt(object, ...)

## S3 method for class 'cpt'
as.seg_cpt(object, ...)

## S3 method for class 'wbs'
as.seg_cpt(object, ...)

is_segmenter(object, ...)

Arguments

object	A tidycpt or segmenter object
...	Arguments passed to methods

Details

tidycpt objects have a segmenter component (that is typically created by a class to segment()). The functions documented here are convenience utility functions for working with the segmenter components. as.segmenter() is especially useful in pipelines to avoid having to use the $ or [ notation for subsetting.

as.segmenter() simply returns the segmenter of a tidycpt object.

as.seg_cpt() takes a wild-caught segmenter object of arbitrary class and converts it into a seg_cpt object.

is_segmenter() checks to see if a segmenter object implements all of the S3 methods necessary to be considered a segmenter.

Value

• as.segmenter() returns the segmenter object of a tidycpt object. Note that this could be of any class, depending on the class returned by the segmenting function.

• as.seg_cpt() returns a seg_cpt object

• is_segmenter() a logical vector of length 1

See Also

Other tidycpt-generics: as.model(), changepoints(), diagnose(), fitness(), model_name()

Other segmenter-functions: fitness(), model_args(), seg_params()

Examples

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

# Return the segmenter component
x |>
  as.segmenter()
  
# Note the class of this object could be anything
x |>
  as.segmenter() |>
  class()
  
# Convert the segmenter into the standardized seg_cpt class
x |>
  as.segmenter() |>
  as.seg_cpt()

# Is the segmenter valid?
x |>
  as.segmenter() |>
  is_segmenter()

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