getdate {bizdays}R Documentation

Obtaining dates using other dates (or month or year) as reference

Description

Imagine you have one date and want the first or last day of this date's month. For example, you have the date 2018-02-01 and want the last day of its month. You have to check whether or not its year is a leap year, and this sounds a tough task. getdate helps with returning specific dates according to a reference than can be another date, a month or an year.

Usage

getdate(expr, ref, cal = bizdays.options$get("default.calendar"))

Arguments

expr

a character string specifying the date to be returned (see Details)

ref

a ref object (see Details)

cal

the calendar's name

expr represents the day has to be returned, here it follows a few examples:

  • "second day"

  • "10th bizday"

  • "3rd wed"

  • "last bizday"

  • "first fri"

expr is a character string with two terms: "<position> <day>"

  • positions: first or 1st, second or 2nd, third or 3rd, last and XXth (examples 6th or 11th)

  • days: day, bizday, or weekdays (sun, mon, tue, wed, thu, fri, sat)

getdate returns dates according to a reference that can be a month or an year. This reference is build with the ref object. The ref object specifies a month or an year based on a date or the month and year can be directly specified.

See Also

ref

Examples

getdate("first day", ref("2018-01-01", ym = "month"), "actual")
getdate("10th wed", ref(2018), "actual")
getdate("last bizday", ref(2010:2018), "Brazil/ANBIMA")
dts <- seq(as.Date("2018-01-01"), as.Date("2018-12-01"), "month")
getdate("first bizday", ref(dts, ym = "month"), "Brazil/ANBIMA")

[Package bizdays version 1.0.6 Index]