var_info: Information about variables

In gEcon: General Equilibrium Economic Modelling Language and Solution Framework (gEcon)

Description

The var_info function allows to create an object of gecon_var_info class, containing information about selected model variables. It allows to check variables' equation incidence matrix as well as the already computed statistics for them.

Usage

var_info(model, variables = NULL, all = FALSE)

Arguments

model	an object of gecon_model class.
variables	the names or indices of the variables of interest.
all	logical value. If TRUE, information about all model variables is generated (FALSE by default).

Details

The var_info function may be useful while debugging a model. It allows also to retrieve information quickly when a model is large. If the R command is not assigned to any R object, the information about the requested variables is printed to the console. Depending on which operations have been performed on an object of gecon\_model class, the information printed consists of a subset of the following elements:

• incidence information,

• steady-state (equilibrium) values,

• variables info (which variables are log-linearised and which are state variables),

• state variables impact on the selected variables,

• shocks' impact on the selected variables,

• basic statistics,

• correlations.

Value

An object of gecon_var_info-class class.

Note

The function only displays and returns the model's characteristics that have been already set or computed. Eg. if the model has been solved but the statistics have not been computed, the correlations will not be passed to the object of gecon_var_info class.

See Also

shock_info for information about the shocks.
get_ss_values, get_pert_solution, get_model_stats to extract statistics of the model variables.

Examples

# copy the example to the current working directory
file.copy(from = file.path(system.file("examples", package = "gEcon"),
          "rbc.gcn"), to = getwd())

# make and load the model
rbc <- make_model("rbc.gcn")

# solve the model
rbc <- steady_state(rbc)
rbc <- solve_pert(rbc)

# get information about variables
rbc_var_info <- var_info(rbc, variables = c("K_s"))
print(rbc_var_info)
show(rbc_var_info)
summary(rbc_var_info)

gEcon documentation built on May 2, 2019, 6:52 p.m.