1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
function plot_contributions(equationname, ds1, ds0)
%function plot_contributions(equationname, ds1, ds0)
% Plots the contribution to the lhs variable of the rhs variables in an equation.
%
% INPUTS
% - equationname [string] Name of an equation.
% - ds1 [string, dseries] Object containing all the variables (exogenous and endogenous)
% appearing in the equation, or the name of the dseries object.
% - ds0 [string, dseries] Object containing the baseline for all the variables (exogenous
% and endogenous) appearing in the equation, or the name of the
% dseries object.
%
% OUTPUTS
% none
%
% SPECIAL REQUIREMENTS
% The user must have attached names to the equations using equation
% tags. Each equation in the model block must be preceeded with a
% tag (see the reference manual). For instance, we should have
% something as:
%
% [name='Phillips curve']
% pi = beta*pi(1) + slope*y + lam;
% Copyright © 2017-2021 Dynare Team
%
% This file is part of Dynare.
%
% Dynare is free software: you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation, either version 3 of the License, or
% (at your option) any later version.
%
% Dynare is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License
% along with Dynare. If not, see <https://www.gnu.org/licenses/>.
global M_
jsonfile = [M_.fname filesep() 'model' filesep() 'json' filesep() 'modfile-original.json'];
if exist(jsonfile, 'file') ~= 2
error('Could not find %s! Please use the json option (See the Dynare invocation section in the reference manual).', jsonfile);
end
% Check the number of input arguments.
if nargin>3
error('plot_contributions:: Exactly three arguments are required!')
end
% Check the type of the first argument
if ~ischar(equationname)
error('First argument must be a string.')
end
% Check that the equation name is actually the name of an equation in the model.
if ~ismember(equationname, M_.equations_tags(strmatch('name', M_.equations_tags(:,2)),3))
error('There is no equation named as %s!', equationname);
end
% Check second argument
if ischar(ds1)
if ismember(ds1, evalin('caller','who'))
ds = evalin('caller', ds1);
if isdseries(ds)
ds1 = copy(ds); clear ds;
else
error('plot_contributions:: %s is not a dseries object!', ds1)
end
else
error('plot_contributions:: %s is unknown!', ds1)
end
else
if ~isdseries(ds1)
error('plot_contributions:: Second input argument must be a dseries object!')
end
end
% Check third argument
if ischar(ds0)
if ismember(ds0, evalin('caller','who'))
ds = evalin('caller', ds0);
if isdseries(ds)
ds0 = copy(ds); clear ds;
else
error('plot_contributions:: %s is not a dseries object!', ds0)
end
else
error('plot_contributions:: %s is unknown!', ds0)
end
else
if ~isdseries(ds0)
error('plot_contributions:: Third input argument must be a dseries object!')
end
end
% Get equation.
[~, jsonmodel] = get_ast(equationname);
lhs = jsonmodel{1}.lhs;
rhs = jsonmodel{1}.rhs;
% Get variable and parameter names in the equation.
rhs_ = strsplit(rhs,{'+','-','*','/','^','log(','diff(','adl(','exp(','(',')'});
rhs_(cellfun(@(x) all(isstrprop(x, 'digit')+isstrprop(x, 'punct')), rhs_)) = []; % Remove numbers
pnames = M_.param_names;
vnames = setdiff(rhs_, pnames);
pnames = setdiff(rhs_, vnames);
regexprnoleads = cell2mat(strcat('(', vnames, {'\(\d+\))|'}));
if ~isempty(regexp(rhs, regexprnoleads(1:end-1), 'match'))
error(['plot_contributions: you cannot have leads in equation on line ' lineno ': ' lhs ' = ' rhs]);
end
% Get values for the parameters
if ~isempty(pnames)
% In case all the parameters are hard coded
idp = strmatch(pnames{1}, M_.param_names, 'exact');
str = sprintf('%s = M_.params(%d);', pnames{1}, idp);
for i=2:length(pnames)
idp = strmatch(pnames{i}, M_.param_names, 'exact');
str = sprintf('%s %s = M_.params(%d);', str, pnames{i}, idp);
end
eval(str)
end
% Replace variables with ds.variablename
for i = 1:length(vnames)
if ismember(vnames{i}, ds1.name) && ismember(vnames{i}, ds0.name)
% Match all words with vnames{i}
[b, e] = regexp(rhs, sprintf('\\w*%s\\w*', vnames{i}));
% Filter out non exact matches (words longer than vnames{i})
rid = find(~(e-b>=length(vnames{i})));
if ~isempty(rid)
b = b(rid);
e = e(rid);
end
% Substitute vnames{i} exact matches by ds.vnames{i}
for j=length(rid):-1:1
if b(j)>1 && e(j)<length(rhs)
rhs = sprintf('%sds.%s%s', rhs(1:b(j)-1), vnames{i}, rhs(e(j)+1:end));
elseif isequal(b(j), 1)
rhs = sprintf('ds.%s%s', vnames{i}, rhs(e(j)+1:end));
elseif isequal(e(j), length(rhs))
rhs = sprintf('%sds.%s', rhs(1:b(j)-1), vnames{i});
end
end
else
if ismember(vnames{i}, ds1.name)
error('Variable %s is not available in the second dseries (baseline paths)!', vnames{i})
else
error('Variable %s is not available in the first dseries (actual paths)!', vnames{i})
end
end
end
% Initialize an array for the contributions.
contribution = zeros(ds1.nobs, ds1.vobs + 1);
% Evaluate RHS with all the actual paths.
ds = ds1;
rhseval = eval(rhs);
ds = ds0;
rhseval_other = eval(rhs);
contribution(:, 1) = rhseval.data - rhseval_other.data;
% Evaluate RHS with the baseline paths.
ds = ds0;
rhs0 = eval(rhs);
% Compute the marginal effect of each variable on the RHS, by evaluating the
% RHS with all variables at the Baseline paths except one for which the
% actual path is used.
for i = 1:length(vnames)
ds = ds0; % Set all variable to Baseline paths.
ds{vnames{i}} = ds1{vnames{i}};
rhsval = eval(rhs)-rhs0;
contribution(:, i+1) = rhsval.data;
end
% Create the contributions plot.
figure('Name', lhs);
hold on
cc = contribution(:,2:end);
% Limit the matrices to what we care about
ccneg = cc(:,1:length(vnames)); ccneg(ccneg>=0) = 0;
ccpos = cc(:,1:length(vnames)); ccpos(ccpos<0) = 0;
H = bar(1:ds.nobs, ccneg, 'stacked');
if ~isoctave && ~matlab_ver_less_than('9.7')
% For MATLAB ≥ R2019b, use the same color indexing scheme as with older releases
set(gca,'ColorOrderIndex',1);
end
B = bar(1:ds.nobs, ccpos, 'stacked');
line_ = plot(1:ds.nobs, contribution(:,1), '-r', 'linewidth', 2);
hold off
lhs = strrep(lhs, '_', '\_');
title(sprintf('Decomposition of %s', lhs))
vnames = strrep(vnames,'_','\_');
if ~isoctave
legend([H, line_], [vnames, lhs], 'location', 'northwest');
else
% Under Octave, H is a column vector
legend([H; line_], [vnames, lhs], 'location', 'northwest');
end
|
