calcRevision {hpiR}

Calculate revision values of an index

Description

Create estimates of the revision statistics for a house price index

Usage

calcRevision(series_obj, in_place = FALSE, in_place_name = "rev",
  smooth = FALSE, ...)

Arguments

series_obj

A list of progressively longer indexes (a 'serieshpi“ object from 'createSeries()“)

in_place

default = FALSE; Calculating in place (adding to hpi)

in_place_name

default = 'rev'; Name of revision object in_place

smooth

default = FALSE; Use smoothed indexes

...

Additional Arguments

Value

list of length 3 containing:

period

Data.frame containing the period number, mean and median for that period

mean

Mean revision for all periods

median

Median revision for all periods

Further Details

The revision object can be generate "in place" inside of the 'serieshpi' object by setting 'in_place' equal to TRUE.

Examples

# Load example sales
 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))

 # Calculate revision
 series_rev <-  calcRevision(series_obj = hpi_series)