bimets: GETYEARPERIOD – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

GETYEARPERIOD

Get Time Series Year-Period

Description

This function returns a two-element list (or a two-columns matrix in the case of JOIN=TRUE) built with the the years and the periods of the input time series observations. Users can provide the output list names. TSDATES is an alias for GETYEARPERIOD.

Usage

GETYEARPERIOD(x=NULL, YEARS='YEAR', PERIODS='PRD', JOIN=FALSE, avoidCompliance=FALSE, ...)
TSDATES(x=NULL, YEARS='YEAR', PERIODS='PRD',  JOIN=FALSE, avoidCompliance=FALSE, ...)

Arguments

`x`	Input time series, that must satisfy the compliance control check defined in `is.bimets`
`YEARS`	Argument of type string that will be the output list name for the array of observation years.
`PERIODS`	Argument of type string that will be the output list name for the array of observation periods.
`JOIN`	If `TRUE`, the output will be a matrix having each row built with the year and the period of the related observation.
`avoidCompliance`	If `TRUE`, compliance control check of input time series will be skipped. See `is.bimets`
`...`	Backward compatibility.

Value

This function returns an object of class list(). If JOIN=TRUE, this function returns a matrix.

Examples

#create quarterly ts
  n=20
  ts1=TSERIES((n:1),START=c(2000,1),FREQ=4)
  myYP=GETYEARPERIOD(ts1)
  print(myYP$YEAR) #print 2000 2000 ... 
  print(myYP$PRD) #print 1 2 3 4 1 2 ...
  
  #create monthly ts
  ts1=TSERIES((n:1),START=c(2000,1),FREQ='M')
  myYP=GETYEARPERIOD(ts1)
  print(myYP$YEAR) #print 2000 2000 ... 
  print(myYP$PRD) #print 1 2 3 4 5 6 7 ...
  
  #create yearly ts
  ts1=TSERIES((1:n),START=c(2000,1),FREQ=1)
  myYP=GETYEARPERIOD(ts1,YEARS='YEARSS', PERIODS='PRDSS')
  print(myYP$YEARSS) #print 2000 2001 2002 ... 
  print(myYP$PRDSS) #print 1 1 1 1.....
  
  #JOIN=TRUE
  ts1=TSERIES((n:1),START=c(2000,1),FREQ='M')
  myYP=GETYEARPERIOD(ts1,JOIN=TRUE)
  print(myYP) #print 2000 2000 ... 
  #      [,1] [,2]
  #[1,] 2000    1
  #[2,] 2000    2
  #[3,] 2000    3
  #...

bimets

Time Series and Econometric Modeling

v1.5.3

GPL-3

Authors

Andrea Luciani [aut, cre], Roberto Stok [aut], Bank of Italy [cph]

Initial release

2021-02-04