hpiR (version 0.2.0)

plot.hpiindex: Plot method for `hpiindex` object

Description

Specific plotting method for hpiindex objects

Usage

# S3 method for hpiindex
plot(x, show_imputed = FALSE, smooth = FALSE, ...)

Arguments

x

Object to plot of class `hpiindex``

show_imputed

default = FALSE; highlight the imputed points

smooth

default = FALSE; plot the smoothed index

...

Additional Arguments

Value

`plotindex` object inheriting from a ggplot object

Examples

# NOT RUN {
 # Load data
 data(ex_sales)

 # With a raw transaction data.frame
 rt_data <- rtCreateTrans(trans_df = ex_sales,
                          prop_id = 'pinx',
                          trans_id = 'sale_id',
                          price = 'sale_price',
                          periodicity = 'monthly',
                          date = 'sale_date')

 # Create model object
 hpi_model <- hpiModel(hpi_df = rt_data,
                       estimator = 'base',
                       log_dep = TRUE)

 # Create Index
 hpi_index <- modelToIndex(hpi_model,
                           max_period = 84)

 # Make Plot
 plot(hpi_index)

# }