model_description {markets} | R Documentation |
Short model and market descriptions
Description
name
A unique identifying string for the model.
describe
A short (one-liner) description of the market model.
market_type
A market type string (equilibrium or disequilibrium) for a given model.
Usage
name(object)
describe(object)
market_type(object)
## S4 method for signature 'market_model'
name(object)
## S4 method for signature 'market_model'
describe(object)
## S4 method for signature 'market_model'
market_type(object)
## S4 method for signature 'market_fit'
name(object)
## S4 method for signature 'market_fit'
describe(object)
## S4 method for signature 'market_fit'
market_type(object)
Arguments
object |
A model object. |
Value
name
The model's name.
describe
The model's description.
market_type
The model's market type.
Functions
-
name()
: Model name -
describe()
: Model description -
market_type()
: Market type
Examples
# initialize the equilibrium using the houses dataset
model <- new(
"diseq_basic", # model type
subject = ID, time = TREND, quantity = HS, price = RM,
demand = RM + TREND + W + CSHS + L1RM + L2RM + MONTH,
supply = RM + TREND + W + L1RM + MA6DSF + MA3DHF + MONTH,
fair_houses()
)
# model name
name(model)
# model description
describe(model)
# market type
market_type(model)
[Package markets version 1.1.5 Index]