File: trace_plot.m

package info (click to toggle)
dynare 7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 79,248 kB
  • sloc: cpp: 82,011; ansic: 28,583; objc: 12,573; yacc: 5,105; pascal: 2,374; lex: 1,502; python: 1,118; sh: 1,116; makefile: 605; lisp: 162; xml: 18
file content (224 lines) | stat: -rw-r--r-- 7,825 bytes parent folder | download
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
function trace_plot(options_,M_,estim_params_,type,blck,name1,name2,name3)
% This function builds trace plot for the Metropolis-Hastings draws.
%
% INPUTS
%
%   options_        [structure]    Dynare structure.
%   M_              [structure]    Dynare structure (related to model definition).
%   estim_params_   [structure]    Dynare structure (related to estimation).
%   type            [string]       'DeepParameter', 'MeasurementError' (for measurement equation error),
%                                  'StructuralShock' (for structural shock)
%                                  or 'PosteriorDensity (for posterior density)'
%   blck            [integer]      Number of the mh chain or chains if a
%                                  vector
%   name1           [string]       Object name.
%   name2           [string]       Object name.
%   name3           [string]       Object name.
%
% OUTPUTS
%   None
%
% SPECIAL REQUIREMENTS

% Copyright © 2003-2026 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/>.

% Get the column index:
if strcmpi(type,'PosteriorDensity')
    column=0;
    name1='';
else
    if nargin<7
        column = name2index(M_, estim_params_, type, name1);
    elseif nargin<8
        column = name2index(M_, estim_params_, type, name1, name2);
    elseif nargin<9
        column = name2index(M_, estim_params_, type, name1, name2, name3);
    end
end

if isempty(column)
    return
end

if ~issmc(options_)
    options_.mh_drop=0; % locally, do not drop as we want all draws
    n_nblocks_to_plot=length(blck);
else
    if ishssmc(options_)
        n_nblocks_to_plot=1;
    elseif isdime(options_)
        error('trace_plot:: DIME does not support the trace_plot command')
    end
end

[~, ~, TotalNumberOfMhDraws]=set_number_of_subdraws(M_,options_);

if n_nblocks_to_plot==1
% Get all the posterior draws:
    PosteriorDraws = GetAllPosteriorDraws(options_, M_.dname,M_.fname,column, 1, 1, blck);
else
    PosteriorDraws=NaN(TotalNumberOfMhDraws,n_nblocks_to_plot);
    save_string='';
    if options_.TeX
        title_string_tex='';
    end
    for block_iter=1:n_nblocks_to_plot
        PosteriorDraws(:,block_iter) = GetAllPosteriorDraws(options_, M_.dname, M_.fname, column, 1, 1, blck(block_iter));
        save_string=[save_string,'_',num2str(blck(block_iter))];
        if options_.TeX
            title_string_tex=[title_string_tex, ', ' num2str(blck(block_iter))];
        end
    end
    save_string(1)=[];
    if options_.TeX
        title_string_tex(1:2)=[];
    end
end

% Plot the posterior draws:

if strcmpi(type,'DeepParameter')
    TYPE = 'parameter ';
elseif strcmpi(type,'StructuralShock')
    if nargin<7
        TYPE = 'the standard deviation of structural shock ';
    elseif nargin<8
        TYPE = 'the correlation between structural shocks ';
    elseif nargin<9
        if strcmp(name1,name2) && strcmp(name1,name3)
            TYPE = 'the skewness coefficient of structural shock ';
        else
            TYPE = 'the skewness coefficient between structural shocks ';
        end
    end
elseif strcmpi(type,'MeasurementError')
    if nargin<7
        TYPE = 'the standard deviation of measurement error ';
    else
        TYPE = 'the correlation between measurement errors ';
    end
elseif strcmpi(type,'InitialState')
    TYPE='the initial state variable ';
elseif strcmpi(type,'PosteriorDensity')
    TYPE='the posterior density';
end

if nargin<7
    FigureName = ['Trace plot for ' TYPE name1];
elseif nargin<8
    FigureName = ['Trace plot for ' TYPE name1 ' and ' name2];
elseif nargin<9
    if strcmp(name1,name2) && strcmp(name1,name3)
        FigureName = ['Trace plot for ' TYPE name1];
    else
        FigureName = ['Trace plot for ' TYPE name1 ', ' name2 ', and ' name3];
    end
end


if n_nblocks_to_plot==1
    if options_.mh_nblck>1
        FigureName = [ FigureName , ' (block number ' int2str(blck)  ').'];
    end
    hh_fig=dyn_figure(options_.nodisplay,'Name',FigureName);
    plot(1:TotalNumberOfMhDraws,PosteriorDraws,'Color',[.7 .7 .7]);

    % Compute the moving average of the posterior draws:
    N = options_.trace_plot_ma;
    MovingAverage = NaN(TotalNumberOfMhDraws,1);
    first = N+1;
    last = TotalNumberOfMhDraws-N;

    for t=first:last
        MovingAverage(t) = mean(PosteriorDraws(t-N:t+N));
    end

    hold on
    plot(1:TotalNumberOfMhDraws,MovingAverage,'-k','linewidth',2)
    hold off
    axis tight
    legend({'MCMC draw';[num2str(N) ' period moving average']},'Location','NorthEast')
else
    hh_fig=dyn_figure(options_.nodisplay,'Name',FigureName);
    pp=plot(1:TotalNumberOfMhDraws,PosteriorDraws);
    legend(pp,strcat(repmat({'Chain '},n_nblocks_to_plot,1),num2str(blck(:))));
end
% create subdirectory <dname>/graphs if it doesn't exist
if ~isfolder(M_.dname)
    mkdir('.',M_.dname);
end
if ~isfolder([M_.dname filesep 'graphs'])
    mkdir(M_.dname,'graphs');
end

%get name for plot
if strcmpi(type,'PosteriorDensity')
    plot_name='Posterior';
else
    plot_name=get_the_name(column,0,M_,estim_params_,options_.varobs);
end
if n_nblocks_to_plot==1
    plot_name=[plot_name,'_blck_',num2str(blck)];
else
    plot_name=[plot_name,'_blck_',save_string];
end
dyn_saveas(hh_fig,[M_.dname, filesep, 'graphs', filesep, 'TracePlot_' plot_name],options_.nodisplay,options_.graph_format)

if options_.TeX
    fid=fopen([M_.dname,'/graphs/',M_.fname,'_TracePlot_' plot_name,'.tex'],'w+');

    if strcmpi(type,'DeepParameter')
        tex_names=M_.param_names_tex;
        base_names=M_.param_names;
    elseif strcmpi(type,'StructuralShock')
        tex_names=M_.exo_names_tex;
        base_names=M_.exo_names;
    elseif ismember(type,{'MeasurementError','InitialState'})
        tex_names=M_.endo_names_tex;
        base_names=M_.endo_names;
    end

    if strcmpi(type,'PosteriorDensity')
        FigureName = ['Trace plot for ' TYPE name1];
    else
        if nargin<7
            FigureName = ['Trace plot for ' TYPE '$' tex_names{strmatch(name1,base_names,'exact')} '$'];
        elseif nargin<8
            FigureName = ['Trace plot for ' TYPE '$' tex_names{strmatch(name1,base_names,'exact')} '$ and $' tex_names{strmatch(name2,base_names,'exact')} '$'];
        elseif nargin<9
            if strcmp(name1,name2) && strcmp(name1,name3)
                FigureName = ['Trace plot for ' TYPE '$' tex_names{strmatch(name1,base_names,'exact')} '$'];
            else
                FigureName = ['Trace plot for ' TYPE '$' tex_names{strmatch(name1,base_names,'exact')} '$, $' tex_names{strmatch(name2,base_names,'exact')} '$, and $' tex_names{strmatch(name3,base_names,'exact')} '$'];
            end
        end
    end
    if n_nblocks_to_plot==1
        if options_.mh_nblck>1
            FigureName = [ FigureName , ' (block number ' int2str(blck)  ').'];
        end
    else
        FigureName = [ FigureName , ' (blocks ' title_string_tex  ').'];
    end
    fprintf(fid,'%-s\n','\begin{figure}[H]');
    fprintf(fid,'%-s\n','\centering');
    fprintf(fid,'%-s\n',['  \includegraphics[width=0.8\textwidth]{',[M_.dname, '/graphs/TracePlot_' plot_name],'}\\']);
    fprintf(fid,'%-s\n',['    \caption{',FigureName,'}']);
    fprintf(fid,'%-s\n','\end{figure}');
    fclose(fid);
end