R: Add a seasonal component with specified period, number of...

add_seasonality {prophet} | R Documentation

## Add a seasonal component with specified period, number of Fourier components, and prior scale.

### Description

Increasing the number of Fourier components allows the seasonality to change more quickly (at risk of overfitting). Default values for yearly and weekly seasonalities are 10 and 3 respectively.

### Usage

    add_seasonality(
      m,
      name,
      period,
      fourier.order,
      prior.scale = NULL,
      mode = NULL,
      condition.name = NULL
    )

### Arguments

`m` | Prophet object.
`name` | String name of the seasonality component.
`period` | Float number of days in one period.
`fourier.order` | Int number of Fourier components to use.
`prior.scale` | Optional float prior scale for this component.
`mode` | Optional 'additive' or 'multiplicative'.
`condition.name` | String name of the seasonality condition.

### Details

Increasing prior scale will allow this seasonality component more flexibility, decreasing will dampen it. If not provided, will use the seasonality.prior.scale provided on Prophet initialization (defaults to 10).

Mode can be specified as either 'additive' or 'multiplicative'. If not specified, m$seasonality.mode will be used (defaults to 'additive'). Additive means the seasonality will be added to the trend, multiplicative means it will multiply the trend.

If condition.name is provided, the dataframe passed to 'fit' and 'predict' should have a column with the specified condition.name containing booleans which decides when to apply seasonality.

### Value

The prophet model with the seasonality added.

[Package prophet version 0.6.1 Index]