Skip to contents

General Interface for Cosinor Regression Models

Source: R/cosinor-constructor.R
cosinor_reg.Rd

cosinor_reg() is a parsnip friendly method for specification of cosinor regression model before fitting.

Usage

cosinor_reg(mode = "regression", period = NULL)

# S3 method for class 'cosinor_reg'
update(object, period = NULL, fresh = FALSE, ...)

# S3 method for class 'cosinor_reg'
print(x, ...)

Arguments

mode

A character string that describes the type of model. In this case, it only supports type of "regression".

period

A non-negative number or vector of numbers that represent the expected periodicity of the data to be analyzed.

object

Cosinor model specification

fresh

A logical for whether the arguments should be modified in place or replaced altogether

...

Extensible

x

Cosinor model specification

Examples

library(parsnip)
cosinor_reg(period = c(24, 8)) |>
  parsnip::set_engine("card") |>
  parsnip::set_mode("regression")
#> Cosinor Model Specification (regression)
#> 
#> Main Arguments:
#>   period = c(24, 8)
#> 
#> Computational engine: card 
#>