mirror of
https://github.com/saymrwulf/prophet.git
synced 2026-09-05 20:30:32 +00:00
33 lines
1.1 KiB
R
33 lines
1.1 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/prophet.R
|
|
\name{add_seasonality}
|
|
\alias{add_seasonality}
|
|
\title{Add a seasonal component with specified period, number of Fourier
|
|
components, and prior scale.}
|
|
\usage{
|
|
add_seasonality(m, name, period, fourier.order, prior.scale = NULL)
|
|
}
|
|
\arguments{
|
|
\item{m}{Prophet object.}
|
|
|
|
\item{name}{String name of the seasonality component.}
|
|
|
|
\item{period}{Float number of days in one period.}
|
|
|
|
\item{fourier.order}{Int number of Fourier components to use.}
|
|
|
|
\item{prior.scale}{Float prior scale for this component.}
|
|
}
|
|
\value{
|
|
The prophet model with the seasonality added.
|
|
}
|
|
\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.
|
|
}
|
|
\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).
|
|
}
|