timeSpecialDate          package:fCalendar          R Documentation

_S_p_e_c_i_a_l _D_a_t_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     A collection and description of functions for the  generation of
     sequences of dates according to  special date rules. 

     The functions for special 'timeDate' sequences are:

       'timeFirstDayInMonth'    Computes the first day in a given month and year,
       'timeLastDayInMonth'     Computes the last day in a given month and year,
       'timeFirstDayInQuarter'  Computes the first day in a given quarter and year,
       'timeLastDayInQuarter'   Computes the last day in a given quarter and year,
       'timeNdayOnOrAfter'      Computes date that is a "on-or-after" n-day,
       'timeNdayOnOrBefore'     Computes date that is a "on-or-before" n-day,
       'timeNthNdayInMonth'     Computes n-th ocurrance of a n-day in year/month,
       'timeLastNdayInMonth'    Computes the last n-day in year/month.

_U_s_a_g_e:

     timeFirstDayInMonth(charvec, format = "%Y-%m-%d", zone = myFinCenter, 
         FinCenter = myFinCenter)
     timeLastDayInMonth(charvec, format = "%Y-%m-%d", zone = myFinCenter, 
         FinCenter = myFinCenter)

     timeFirstDayInQuarter(charvec, format = "%Y-%m-%d", zone = myFinCenter, 
         FinCenter = myFinCenter)
     timeLastDayInQuarter(charvec, format = "%Y-%m-%d", zone = myFinCenter, 
         FinCenter = myFinCenter)

     timeNdayOnOrAfter(charvec, nday = 1, format = "%Y-%m-%d", 
         zone = myFinCenter, FinCenter = myFinCenter)
     timeNdayOnOrBefore(charvec, nday = 1, format = "%Y-%m-%d", 
         zone = myFinCenter, FinCenter = myFinCenter)

     timeNthNdayInMonth(charvec, nday = 1, nth = 1, format = "%Y-%m-%d", 
         zone = myFinCenter, FinCenter = myFinCenter)
     timeLastNdayInMonth(charvec, nday = 1, format = "%Y-%m-%d", 
         zone = myFinCenter, FinCenter = myFinCenter)

_A_r_g_u_m_e_n_t_s:

 charvec: a character vector of dates and times. 

FinCenter: a character with the the location of the   financial center
          named as "continent/city".  

  format: the format specification of the input character vector. 

    nday: an integer vector with entries ranging from  '0' (Sunday) to
          '6' (Saturday). 

     nth: an integer vector numbering the n-th occurence. 

    zone: the time zone or financial center where the data were
          recorded. 

_D_e_t_a_i_l_s:

     We have implemented functions to generate special '"timeDate"' 
     sequences. These are functions to compute the last day in a given 
     month and year, to compute the dates in a month that is a n-day on
     or  after a given date, to compute the dates in a month that is a
     n-day  on or before a specified date, to compute the n-th
     ocurrances of a  n-day for a specified year/month vectors, and
     finally to compute  the last n-day for a specified year/month
     value or vector. n-days are numbered from 0 to 6 where 0
     correspond to the Sunday and 6 to  the Saturday. 

_V_a_l_u_e:

     'timeLastDayInMonth'
      'timeFirstDayInMonth'
      'timeLastDayInQuarter'
      'timeFirstDayInQuarter'
      'timeNdayOnOrAfter'
      'timeNdayOnOrBefore'
      'timeNthNdayInMonth'
      'timeLastNdayInMonth' 
      these functions return 'timeDate' objects on special dates. For 
     the functions 'timeLastDayInMonth' and 'timeLastDayInMonth' return
     the last or first day respectively in a given month and year. The
     same functionality for quarterly time horizons is returned by the
     functions 'timeLastDayInQuarter' and 'timeLastDayInQuarter'. Ror
     the function 'timeNdayOnOrAfter' the date in the specified  month
     that is a n-day (e.g. Sun-day) on or after a given date, for 
     'timeNdayOnOrBefore' the date that is a n-day on or before a 
     given date, for 'timeNthNdayInMonth' the 'nth' ocurrance  of a
     n-day (nth = 1,...,5) in 'year', 'month', and for
     {timeLastNdayInMonth} the last 'nday' in 'year', 'month' will be
     returned as '"timeDate"' objects.

_A_u_t_h_o_r(_s):

     Diethelm Wuertz for the Rmetrics R-port.

_S_e_e _A_l_s_o:

     'timeDate'

_E_x_a_m_p_l_e_s:

     ## Date as character String:
        charvec = "2006-04-16"
         
     ## timeLastDayInMonth-
        # What date has the last day in a month for a given date ?
        timeLastDayInMonth(charvec, format = "%Y-%m-%d", 
          zone = myFinCenter, FinCenter = myFinCenter)
        timeLastDayInMonth(charvec)
        timeLastDayInMonth(charvec, FinCenter = "Zurich")
        
     ## timeFirstDayInMonth -
        # What date has the first day in a month for a given date ?
        timeFirstDayInMonth(charvec)
         
     ## timeLastDayInQuarter -
        # What date has the last day in a quarter for a given date ?
        timeLastDayInQuarter(charvec)
         
     ## timeFirstDayInQuarter -
        # What date has the first day in a quarter for a given date ?
        timeFirstDayInQuarter(charvec)
         
     ## timeNdayOnOrAfter
        # What date has the first Monday on or after March 15, 1986 ?
        timeNdayOnOrAfter("1986-03-15", 1)
         
     ## timeNdayOnOrBefore
        # What date has Friday on or before April 22, 1977 ?
        timeNdayOnOrBefore("1986-03-15", 5)
         
     ## timeNthNdayInMonth -
        # What date is the second Monday in April 2004 ?
        timeNthNdayInMonth("2004-04-01", 1, 2)
         
     ## timeLastNdayInMonth -
        # What date has the last Tuesday in May, 1996 ?
        timeLastNdayInMonth("1996-05-01", 2)

