Retrieve the arguments that a model-fitting function used

Retrieve the arguments that a model-fitting function used

Usage

model_args(object, ...)

# Default S3 method
model_args(object, ...)

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

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

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

# S3 method for class 'cptga'
model_args(object, ...)

# S3 method for class 'segmented'
model_args(object, ...)

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

Arguments

object

A segmenter object.

...

currently ignored

Value

A named list of arguments, or NULL

Details

Every model is fit by a model-fitting function, and these functions sometimes take arguments. model_args() recovers the arguments that were passed to the model fitting function when it was called. These are especially important when using a genetic algorithm.

See also

Other model-fitting: fit_arima(), fit_lmshift(), fit_meanshift(), fit_meanvar(), fit_nhpp(), model_name(), new_fun_cpt(), whomademe()

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

Examples

# Segment a time series using Coen's algorithm
x <- segment(CET, method = "ga-coen", maxiter = 3)
#> Seeding initial population with probability: 0.0327868852459016

# Recover the arguments passed to the model-fitting function
x |>
  as.segmenter() |>
  model_args()
#> $model_fn
#> [1] "nhpp"
#> 
#> $penalty_fn
#> [1] "BMDL"
#>