add_country_holidays.Rd 762 B

12345678910111213141516171819202122232425262728
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/prophet.R
  3. \name{add_country_holidays}
  4. \alias{add_country_holidays}
  5. \title{Add in built-in holidays for the specified country.}
  6. \usage{
  7. add_country_holidays(m, country_name)
  8. }
  9. \arguments{
  10. \item{m}{Prophet object.}
  11. \item{country_name}{Name of the country, like 'UnitedStates' or 'US'}
  12. }
  13. \value{
  14. The prophet model with the holidays country set.
  15. }
  16. \description{
  17. These holidays will be included in addition to any specified on model
  18. initialization.
  19. }
  20. \details{
  21. Holidays will be calculated for arbitrary date ranges in the history
  22. and future. See the online documentation for the list of countries with
  23. built-in holidays.
  24. Built-in country holidays can only be set for a single country.
  25. }