Add headers and more documentation to shock_decomposition.m and graph_decomp.m

time-shift
Johannes Pfeifer 2015-07-24 10:08:43 +02:00
parent 3fdda5412f
commit 36e7bcdbcd
3 changed files with 17 additions and 4 deletions

View File

@ -6137,7 +6137,9 @@ which the shock decomposition has been requested. The second dimension stores
in the first @code{M_.exo_nbr} columns the contribution of the respective shocks.
Column @code{M_.exo_nbr+1} stores the contribution of the initial conditions,
while column @code{M_.exo_nbr+2} stores the smoothed value of the respective
endogenous variable. The third dimension stores the time periods.
endogenous variable. The third dimension stores the time periods. Both the variables
and shocks are stored in the order of declaration, i.e. @code{M_.endo_names} and
{M_.exo_names}, respectively.
@end deffn

View File

@ -1,7 +1,17 @@
function []=graph_decomp(z,shock_names,endo_names,i_var,initial_date,DynareModel,DynareOptions)
%function []=graph_decomp(z,varlist,initial_period,freq)
%function []=graph_decomp(z,shock_names,endo_names,i_var,initial_date,DynareModel,DynareOptions)
% Plots the results from the shock_decomposition command
%
% Inputs
% z [n_var*(nshock+2)*nperiods] shock decomposition array, see shock_decomposition.m for details
% shock_names [endo_nbr*string length] shock names from M_.exo_names
% endo_names [exo_nbr*string length] variable names from M_.endo_names
% i_var [n_var*1] vector indices of requested variables in M_.endo_names and z
% initial_date [dseries object] first period of decomposition to plot
% DynareModel [structure] Dynare model structure
% DynareOptions [structure] Dynare options structure
% Copyright (C) 2010-2013 Dynare Team
% Copyright (C) 2010-2015 Dynare Team
%
% This file is part of Dynare.
%

View File

@ -4,7 +4,8 @@ function oo_ = shock_decomposition(M_,oo_,options_,varlist)
% oo_.shock_decomposition. It is a n_var by nshock+2 by nperiods array. The
% first nshock columns store the respective shock contributions, column n+1
% stores the role of the initial conditions, while column n+2 stores the
% value of the smoothed variables.
% value of the smoothed variables. Both the variables and shocks are stored
% in the order of declaration, i.e. M_.endo_names and M_.exo_names, respectively.
%
% INPUTS
% M_: [structure] Definition of the model