add_seasonality.Rd 760 B

123456789101112131415161718192021222324252627
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/prophet.R
  3. \name{add_seasonality}
  4. \alias{add_seasonality}
  5. \title{Add a seasonal component with specified period and number of Fourier
  6. components.}
  7. \usage{
  8. add_seasonality(m, name, period, fourier.order)
  9. }
  10. \arguments{
  11. \item{m}{Prophet object.}
  12. \item{name}{String name of the seasonality component.}
  13. \item{period}{Float number of days in one period.}
  14. \item{fourier.order}{Int number of Fourier components to use.}
  15. }
  16. \value{
  17. The prophet model with the seasonality added.
  18. }
  19. \description{
  20. Increasing the number of Fourier components allows the seasonality to change
  21. more quickly (at risk of overfitting). Default values for yearly and weekly
  22. seasonalities are 10 and 3 respectively.
  23. }