get_fy {busdater} | R Documentation |
Get a financial year.
Description
get_fy()
returns the current financial (fiscal) year.
It also returns financial year based on parameter dates, or financial year
based on a parameter dates and offset_period in years.
Usage
get_fy(date = Sys.Date(), offset_period = 0,
opt_fy_start = getOption("busdaterFYstart", default = "07-01"))
Arguments
date |
A date vector for which financial year is required. Date must be POSIXct or POSIXlt or Date objects. |
offset_period |
A positive or negative number coercible to
integer to shift the year by,
e.g. in the case of |
opt_fy_start |
A string in the format of "MM-DD" representing the start of financial year, e.g. "01-01" for 1st of January or "07-01" for 1st of July. This package caters for financial years that have a fixed start date. It does not cater for moving dates e.g. last Friday of September. |
Value
An integer vector containing the current financial year if offset
offset_period
is 0, otherwise add the offset offset_period
in years.
See Also
Other business date functions: FY
,
get_boundary
,
period_boundaries
Examples
get_fy() ## return the current financial year as integer
dt <- as.Date(c("01-01-2018", "15-12-2017"), "%d-%m-%Y")
get_fy(date = dt[1])
get_fy(date = dt)
get_fy(offset_period = 1) ## return the next financial year as integer
get_fy(date = dt[1], offset_period = 1)
get_fy(date = dt, offset_period = 1)
get_fy(offset_period=-1) ## return the previous financial year as integer
get_fy(date = dt[1], offset_period = -1)
get_fy(date = dt, offset_period = -1)
## Not run:
get_fy("a") ## will fail because dates are expected.
## End(Not run)