hpiR (version 0.2.0)

plot.seriesaccuracy: Plot method for `seriesaccuracy` object

Description

Specific plotting method for seriesaccuracy objects

Usage

# S3 method for seriesaccuracy
plot(x, return_plot = FALSE, ...)

Arguments

x

Object of class `hpiaccuracy``

return_plot

default = FALSE; Return the plot to the function call

...

Additional argument (passed to `plot.hpiaccuracy()``)

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)

 #  Create Series (Suppressing messages do to small sample size of this example)
 suppressMessages(
    hpi_series <- createSeries(hpi_obj = rt_index,
                               train_period = 12))

 # Calculate insample accuracy
 hpi_series_accr <- calcSeriesAccuracy(series_obj = hpi_series,
                                       test_type = 'rt',
                                       test_method = 'insample')
 # Make Plot
 plot(hpi_series_accr)

# }