plot.hpiindex: Plot method for 'hpiindex' object

Description Usage Arguments Value Examples

View source: R/plotFunctions.R

Description

Specific plotting method for hpiindex objects

Usage

1
2
## S3 method for class '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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 # 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(model_type = 'rt',
                       hpi_df = rt_data,
                       estimator = 'base',
                       log_dep = TRUE)

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

 # Make Plot
 plot(hpi_index)

hpiR documentation built on April 1, 2020, 5:09 p.m.