hpiR (version 0.2.0)

rtIndex: Create a full index object by repeat transaction approach

Description

Wrapper to create index object via entire repeat transaction approach

Usage

rtIndex(trans_df, ...)

Arguments

trans_df

data.frame of transactions. Can be a 'hpidata' or an 'rtdata' object.

...

Additional Arguments

Value

`hpi`` object. S3 list with:

data

`hpidata` object

model

`hpimodel` object

index

`hpiindex` object

Further Details

Additional argument need to provide necessary argument for create `hpidata` objects if the `trans_df` object is not of that class.

Examples

# NOT RUN {
 # Load data
 data(ex_sales)

 # Create index with raw transaction data
 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)

# }