File: add_country_holidays.Rd

package info (click to toggle)
r-cran-prophet 1.0%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 740 kB
  • sloc: makefile: 15; sh: 13
file content (27 lines) | stat: -rw-r--r-- 762 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/prophet.R
\name{add_country_holidays}
\alias{add_country_holidays}
\title{Add in built-in holidays for the specified country.}
\usage{
add_country_holidays(m, country_name)
}
\arguments{
\item{m}{Prophet object.}

\item{country_name}{Name of the country, like 'UnitedStates' or 'US'}
}
\value{
The prophet model with the holidays country set.
}
\description{
These holidays will be included in addition to any specified on model
initialization.
}
\details{
Holidays will be calculated for arbitrary date ranges in the history
and future. See the online documentation for the list of countries with
built-in holidays.

Built-in country holidays can only be set for a single country.
}