seg_params: Retrieve parameters from a segmenter

View source: R/aaa_generics.R

seg_paramsR Documentation

Retrieve parameters from a segmenter

Description

Retrieve parameters from a segmenter

Usage

seg_params(object, ...)

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

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

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

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

Arguments

object

A segmenter object.

...

currently ignored

Details

Most segmenting algorithms have parameters. This function retrieves an informative set of those parameter values.

Value

A named list of parameters with their values.

See Also

Other segmenter-functions: as.segmenter(), fitness(), model_args()

Examples

# Segment a time series using PELT
x <- segment(CET, method = "pelt")
x |>
  as.segmenter() |>
  seg_params()


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