yeartodate - script and chart function

This function finds if the input timestamp falls within the year of the date the script was last loaded, and returns True if it does, False if it does not.

Syntax:

YearToDate(timestamp[ , yearoffset [ , firstmonth [ , todaydate] ] ])

Return data type: Boolean

If none of the optional parameters are used, the year to date means any date within one calendar year from January 1 up to and including the date of the last script execution.

Arguments:

Argument	Description
timestamp	The timestamp to evaluate, for example '2012-10-12'.
yearoffset	By specifying a yearoffset, yeartodate returns True for the same period in another year. A negative yearoffset indicates a previous year, a positive offset a future year. The most recent year-to-date is achieved by specifying yearoffset = -1. If omitted, 0 is assumed.
firstmonth	By specifying a firstmonth between 1 and 12 (1 if omitted) the beginning of the year may be moved forward to the first day of any month. For example, if you want to work with a fiscal year beginning on May 1, specify firstmonth = 5.
todaydate	By specifying a todaydate (timestamp of the last script execution if omitted) it is possible to move the day used as the upper boundary of the period.

The following examples assume last reload time = 2011-11-18

Example	Result
yeartodate( '2010-11-18')	returns False
yeartodate( '2011-02-01')	returns True
yeartodate( '2011-11-18')	returns True
yeartodate( '2011-11-19')	returns False
yeartodate( '2011-11-19', 0, 1, '2011-12-31')	returns True
yeartodate( '2010-11-18', -1)	returns True
yeartodate( '2011-11-18', -1)	returns False
yeartodate( '2011-04-30', 0, 5)	returns False
yeartodate( '2011-05-01', 0, 5)	returns True

yeartodate - script and chart function

Feedback