Financial Market Date Calculations

Implements common date calculations relevant for specifying the economic nature of financial market contracts that are typically defined by International Swap Dealer Association (ISDA, < http://www2.isda.org>) legal documentation. This includes methods to check whether dates are business days in certain locales, functions to adjust and shift dates and time length (or day counter) calculations.


CRAN_Status_Badge License Travis build status Appveyor build status Coverage Status

Motivation

Over-the-counter (OTC) derivatives comprise a significant proportion of trading activity in global financial markets. Their general contractual conventions are specified in what are known as International Swap and Derivatives Association (ISDA) definitions. For example, FX and currency option transactions are governed by the 1998 FX and Currency Options Definitions and swap transactions are governed by the 2006 ISDA Definitions. They describe in meticulous detail, among other things, how the dates of certain financial events should be determined. This includes how dates are defined to be good or bad and how bad dates are to be adjusted to good dates. They also define how to determine the length of time between two dates.

This package implements calendars used to define locale specific business days, date adjusters and shifters, schedule generators and year fraction calculations defined by these standards.

Calendars

You can determine whether dates are business days in a specific locale or specific locales:

library("lubridate", warn.conflicts = FALSE)
library("fmdates")
ausy <- AUSYCalendar()
aume <- AUMECalendar()
syme <- c(ausy, aume) # handy JointCalendar construction approach
is_good(ymd(20140404), ausy)
is_good(ymd(20141104), syme) # Melbourne Cup holiday
#> [1] FALSE
syme$rule <- any
is_good(ymd(20141104), syme)
#> [1] TRUE

Adjusters and shifters

You can adjust (or roll) and shift dates using predefined business day conventions:

# Adjust using the modified following convention
adjust(ymd(20140404), 'mf', ausy)
#> [1] "2014-04-04"
# Shift dates
shift(ymd(20120229), months(1), 'u', ausy, FALSE) # one month
#> [1] "2012-03-29"
shift(ymd(20120229), months(1), 'mf', ausy, TRUE)  # one month with EOM rule
#> [1] "2012-03-30"
shift(ymd(20120229), years(1) + months(3), 'mf', ausy, TRUE)  # 1y3m
#> [1] "2013-05-31"

Schedules

The preceding methods are used to generate schedules of dates required to define common financial contracts events such as cash flow exchange dates:

generate_schedule(effective_date = ymd(20120103), termination_date = ymd(20130103), 
  tenor = months(3), calendar = ausy, bdc = "mf", stub = "short_front", 
  eom_rule = FALSE)
#> [1] 2012-01-03 UTC--2012-04-03 UTC 2012-04-03 UTC--2012-07-03 UTC
#> [3] 2012-07-03 UTC--2012-10-03 UTC 2012-10-03 UTC--2013-01-03 UTC

Year fractions

Time lengths then usually need to be computed for each interval of such a schedule according to some day basis convention:

# 30/360us convention
year_frac(ymd("2010-03-31"), ymd("2012-03-31"), "30/360us")
#> [1] 2
# act/365 convention
year_frac(ymd("2010-02-28"), ymd("2012-03-31"), "act/365")
#> [1] 2.087671

More details can be found in the associated help files and the vignette (vignette("dates", "fmdates")). If you would like to contribute to the package please see the CONTRIBUTING.md file for general as well as specific suggestions.

News

Changes in version 0.1.4

  • is_good() no longer relies on lubridate::wday() abbreviations (#9)
  • Package website is now available. See the DESCRIPTION file for URL (#11)
  • Added specific developer documentation to CONTRIBUTING.md (#12)

Changes in version 0.1.3

  • is_good() methods work when dates are bad and they occur on Tuesdays or Thursdays following changes to lubridate::wday() return values (#7)

Changes in version 0.1.2

  • Exported is_valid_day_basis() and is_valid_bdc() (#5)

Changes in version 0.1.1

  • Fixed error when subsetting a JointCalendar with a logical vector (#3)
  • Removed unnecessary dependency on stats package

Changes in version 0.1.0

  • Initial release
  • Introduces Calendar classes (S3) and associated convenience constructors for key locales
  • Introduces is_good(), adjust(), shift() and generate_schedule() as key calendar related methods
  • Introduces year_frac() function for time length calculations.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("fmdates")

0.1.4 by Imanuel Costigan, 2 months ago


https://github.com/imanuelcostigan/fmdates, https://imanuelcostigan.github.io/fmdates/


Report a bug at https://github.com/imanuelcostigan/fmdates/issues


Browse source code at https://github.com/cran/fmdates


Authors: Imanuel Costigan [aut, cre]


Documentation:   PDF Manual  


Task views: Empirical Finance


GPL-2 license


Imports assertthat, lubridate, methods, utils

Suggests covr, knitr, rmarkdown, testthat


Imported by fmbasics.


See at CRAN