Description Usage Arguments Value See Also Examples
FY()
is a deprecated function. It returns the current financial year.
It also returns financial year based on parameter dates, or financial year
based on a parameter dates and offset_period in years.
1 2 |
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 |
optFYstart |
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. |
An integer vector containing the current financial year if offset
offset_period
is 0, otherwise add the offset offset_period
in years.
Other business date functions: get_boundary
,
get_fy
, period_boundaries
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | FY() # deprecated function returns the current financial year as integer
dt <- as.Date(c("01-01-2018", "15-12-2017"), "%d-%m-%Y")
FY(date = dt[1])
FY(date = dt)
FY(offset_period = 1) ## return the next financial year as integer
FY(date = dt[1], offset_period = 1)
FY(date = dt, offset_period = 1)
FY(offset_period=-1) ## return the previous financial year as integer
FY(date = dt[1], offset_period = -1)
FY(date = dt, offset_period = -1)
## Not run:
FY("a") ## will fail because dates are expected.
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.