smoothSeries {hpiR}

Smooth all indexes in a series

Description

Smooths all indexes within a progressive series of indexes

Usage

smoothSeries(series_obj, order = 3, ...)

Arguments

series_obj

Series to be smoothed

order

Number of nearby period to smooth with

...

Additional Arguments

Value

a 'serieshpi' object with a smoothed index in each 'hpiindex' object

Further Details

Leaving order blank default to a moving average with order 3.

Examples

 # Load data
 data(ex_sales)

 # Create index
 rt_index <- rtIndex(trans_df = ex_sales,
                     periodicity = 'monthly',
                     min_date = '2010-06-01',
                     max_date = '2015-11-30',
                     adj_type = 'clip',
                     date = 'sale_date',
                     price = 'sale_price',
                     trans_id = 'sale_id',
                     prop_id = 'pinx',
                     estimator = 'robust',
                     log_dep = TRUE,
                     trim_model = TRUE,
                     max_period = 48,
                     smooth = FALSE)

 #  Create Series (Suppressing messages do to small sample size of this example)
 suppressMessages(
    hpi_series <- createSeries(hpi_obj = rt_index,
                               train_period = 12))
 # Smooth indexes
 sm_series <- smoothSeries(series_obj = hpi_series,
                           order = 5)