hpiR (version 0.2.0)

plot.seriesrevision: Plot method for `seriesrevision` object

Description

Specific plotting method for seriesrevision objects

Usage

# S3 method for seriesrevision
plot(x, measure = "median", ...)

Arguments

x

Object to plot of class `seriesrevision`

measure

default = 'median'; Metric to plot ('median' or 'mean')

...

Additional Arguments

Value

`plotrevision` object inheriting from a ggplot object

Examples

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

 # Make Plot
 plot(series_rev)

# }