sugar_feast: Create dummies for Sugar feast (estimated by the Umm al-Qura...

Description Usage Arguments Value Examples

View source: R/sugar_feast.R

Description

Create a dummy variable that takes the value 0 or 1 to indicate the abscence or presence of the start of Sugar feast, also known as Eid al-Fitr or Festival of Breaking the Fast. The day(s) before or after this holy holiday can also be recoded by using the pre and post arguments. For example, if you also want to recode the days after Sugar feast, set post argument to 1.

Usage

1
sugar_feast(dates, pre = 0, post = 0)

Arguments

dates

A vector with dates in the format YYYY-MM-DD.

pre

non-negative integer. To encode the days before the holiday dates.

post

non-negative integer. To encode the days after the holiday dates.

Value

A dummy (binary vector).

Examples

1
2
3
4
5
dates <- seq_days("2021-5-10", "2021-5-20")
tibble::tibble(
   dates,
   eid_al_fitr = sugar_feast(dates)
)

Glender/DutchDayDummies documentation built on Feb. 24, 2022, 7:15 a.m.