knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
library(vacancesscolr)

vacancesscolr

Travis build status

The goal of vacancesscolr is to be able to quickly retrieve school holidays in France for the 2008-2018 period and bank holidays for any given year.

The data used in this package has been obtained from Antoine Augusti's vacances-scolaires dataset, under the Etalab license (open license).

The functionalities are direct ports from his vacances-scolaires-france and jours-feries-france Python packages, under MIT license.

Installation

vacancesscolr lives only on Github for now. Please use devtools or remotes to install it.

devtools::install_github("tutuchan/vacancesscolr")
# OR
remotes::install_github("tutuchan/vacancesscolr")

Examples

Holidays

Check if a date is a holiday:

is_holiday("2018-03-05")
is_holiday("2018-03-05", zone = "A")
is_holiday("2018-03-05", zone = "B")

Retrieve all holidays for a year, optional zone and optional type of holiday:

get_holidays(2018, name = "Vacances d'hiver")

You can use shortened names for the holidays names:

holidays_names_full()

holidays_names_short()

Bank holidays

Get all bank holidays for a year:

get_bank_holidays(2018)

Get a specific bank holiday:

bh_lundi_paques(2018)

Get the names of bank holidays (some have multiple ways to call them):

bank_holidays_names()

bank_holidays_names_unique()

Get a bank holiday knowing its name:

bank_holiday("1 mai")(2018)


Tutuchan/vacancesscolr documentation built on Dec. 3, 2019, 6:21 a.m.