hpiR (version 0.2.0)

hpiModel.rtdata: Specific method for hpi modeling (rt approach)

Description

Estimate hpi models with rt approach

Usage

# S3 method for rtdata
hpiModel(hpi_df, estimator = "base", log_dep = TRUE,
  trim_model = TRUE, ...)

Arguments

hpi_df

Dataset created by one of the *CreateTrans() function in this package.

estimator

Type of estimator to be used ('base', 'weighted', 'robust')

log_dep

default TRUE, should the dependent variable (change in price) be logged?

trim_model

default TRUE, should excess be trimmed from model results ('lm' or 'rlm' object)?

...

Additional Arguments

Value

hpimodel object consisting of:

estimator

Type of estimator

coefficients

Data.frame of coefficient

model_obj

class `rtmodel` or `hedmodel`

mod_spec

Full model specification

log_dep

Binary: is the dependent variable in logged format

base_price

Mean price in the base period

periods

`data.frame` of periods

approach

Type of model used