parse_seasonality_args.Rd 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/prophet.R
  3. \name{parse_seasonality_args}
  4. \alias{parse_seasonality_args}
  5. \alias{parse_seasonality_args}
  6. \title{Get number of Fourier components for built-in seasonalities.}
  7. \usage{
  8. parse_seasonality_args(m, name, arg, auto.disable, default.order)
  9. parse_seasonality_args(m, name, arg, auto.disable, default.order)
  10. }
  11. \arguments{
  12. \item{m}{Prophet object.}
  13. \item{name}{String name of the seasonality component.}
  14. \item{arg}{'auto', TRUE, FALSE, or number of Fourier components as
  15. provided.}
  16. \item{auto.disable}{Bool if seasonality should be disabled when 'auto'.}
  17. \item{default.order}{Int default Fourier order.}
  18. \item{m}{Prophet object.}
  19. \item{name}{String name of the seasonality component.}
  20. \item{arg}{'auto', TRUE, FALSE, or number of Fourier components as
  21. provided.}
  22. \item{auto.disable}{Bool if seasonality should be disabled when 'auto'.}
  23. \item{default.order}{Int default Fourier order.}
  24. }
  25. \value{
  26. Number of Fourier components, or 0 for disabled.
  27. Number of Fourier components, or 0 for disabled.
  28. }
  29. \description{
  30. Get number of Fourier components for built-in seasonalities.
  31. Get number of Fourier components for built-in seasonalities.
  32. }
  33. \keyword{internal}