tidychangepoint (version 1.0.0)

seg_params: Retrieve parameters from a segmenter

Description

Retrieve parameters from a segmenter

Usage

seg_params(object, ...)
# S3 method for seg_cpt
seg_params(object, ...)
# S3 method for ga
seg_params(object, ...)
# S3 method for cpt
seg_params(object, ...)
# S3 method for wbs
seg_params(object, ...)

Value

A named list of parameters with their values.

Arguments

object

A segmenter object.

...

currently ignored

Details

Most segmenting algorithms have parameters. This function retrieves an informative set of those parameter 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()