hpiR (version 0.2.0)

plot.hpiaccuracy: Plot method for `hpiaccuracy` object

Description

Specific plotting method for hpiaccuracy objects

Usage

# S3 method for hpiaccuracy
plot(x, return_plot = FALSE, do_plot = TRUE, ...)

Arguments

x

Object to plot of class `hpiaccuracy``

return_plot

default = FALSE; Return the plot to the function call

do_plot

default = FALSE; Execute plotting to terminal/console

...

Additional Arguments

Value

`plotaccuracy` object inheriting from a ggplot object

Examples

# NOT RUN {
 # 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)

 # Calculate insample accuracy
 hpi_accr <- calcAccuracy(hpi_obj = rt_index,
                          test_type = 'rt',
                          test_method = 'insample')

 # Make Plot
 plot(hpi_accr)

# }