holidaylist: Generating a dataframe of all holidays in a year

Description Usage Arguments Details Examples

Description

This function will generate a dataframe containing a list of all holidays containing all the holidays that are taking place within a specified year in a specified country.

Usage

1
2
holidaylist(country = c("US"), year = "2018",
  api_key = Sys.getenv("CALENDARINDEX_API_KEY"))

Arguments

country

a single ISO 3166 country code or a list of ISO 3166 country codes from the 'countrycode' dataset in this package.

year

the year of interest

api_key

personal CalendarIndex API key

Details

The dataframe will include the date of holiday, the country, the name of holiday, and the type of holiday (public, observance, optional, etc).

Examples

1
2
holidaylist("US", "2018", Sys.getenv("CALENDARINDEX_API_KEY"))
holidaylist(c("US", "AD"), "2016", api_key = Sys.getenv("CALENDARINDEX_API_KEY"))

ongzuchengmark/holidayplanneR documentation built on May 21, 2019, 10:12 a.m.