stepan
/
dynare
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: more fixes to documentation

time-shift
Houtan Bastani 2017-03-22 10:52:14 +01:00
parent 4f432b7e58
commit 2be17e1ebd
1 changed files with 29 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
doc/dynare.texi
View File

@ -7066,19 +7066,14 @@ model).
@table @code @table @code
@item parameter_set = @var{PARAMETER_SET} @item parameter_set = @code{calibration} | @code{prior_mode} | @code{prior_mean} | @code{posterior_mode} | @code{posterior_mean} | @code{posterior_median} | @code{mle_mode}
Specify the parameter set to use for running the smoother. The @anchor{parameter_set} Specify the parameter set to use for running the smoother. Note that the
@var{PARAMETER_SET} can take one of the following seven values: parameter set used in subsequent commands like @code{stoch_simul} will be set
@code{calibration}, @code{prior_mode}, @code{prior_mean}, to the specified @code{parameter_set}. Default value: @code{posterior_mean} if
@code{posterior_mode}, @code{posterior_mean},
@code{posterior_median}, @code{mle_mode}. Note that the parameter
set used in subsequent commands like @code{stoch_simul} will be set to
the specified @code{parameter_set}.
Default value: @code{posterior_mean} if
Metropolis has been run, @code{mle_mode} if MLE has been run. Metropolis has been run, @code{mle_mode} if MLE has been run.
@item datafile = @var{FILENAME} @item datafile = @var{FILENAME}
@xref{datafile}. Useful when computing the shock decomposition on a @anchor{datafile_shock_decomp} @xref{datafile}. Useful when computing the shock decomposition on a
calibrated model. calibrated model.
@item first_obs = @var{INTEGER} @item first_obs = @var{INTEGER}
@ -7087,16 +7082,16 @@ calibrated model.
@item nobs = @var{INTEGER} @item nobs = @var{INTEGER}
@xref{nobs}. @xref{nobs}.
@item use_shock_groups [= @var{SHOCK_GROUPS_NAME}] @item use_shock_groups [= @var{STRING}]
@anchor{use_shock_groups} Uses groups of shocks instead of individual shocks in @anchor{use_shock_groups} Uses groups of shocks instead of individual shocks in
the decomposition. Groups of shocks are defined in the @ref{shock_groups} block. the decomposition. Groups of shocks are defined in the @ref{shock_groups} block.
@item colormap = @var{COLORMAP_NAME} @item colormap = @var{STRING}
@anchor{colormap} Controls the colormap used for the shocks decomposition @anchor{colormap} Controls the colormap used for the shocks decomposition
graphs. See @code{colormap} in Matlab/Octave manual. graphs. See @code{colormap} in Matlab/Octave manual for valid arguments.
@item nograph @item nograph
@xref{nograph} Suppresses the display and creation only within the @xref{nograph}. Suppresses the display and creation only within the
@code{shock_decomposition}-command but does not affect other commands. @code{shock_decomposition}-command but does not affect other commands.
@xref{plot_shock_decomposition} for plotting graphs. @xref{plot_shock_decomposition} for plotting graphs.
@ -7201,17 +7196,11 @@ model).
@table @code @table @code
@item parameter_set = @var{PARAMETER_SET} @item parameter_set = @code{calibration} | @code{prior_mode} | @code{prior_mean} | @code{posterior_mode} | @code{posterior_mean} | @code{posterior_median} | @code{mle_mode}
Specify the parameter set to use for running the smoother. @xref{parameter_set}.
@var{PARAMETER_SET} can take one of the following seven values:
@code{calibration}, @code{prior_mode}, @code{prior_mean},
@code{posterior_mode}, @code{posterior_mean},
@code{posterior_median}, @code{mle_mode}. Default value: @code{posterior_mean} if
Metropolis has been run, @code{mle_mode} if MLE has been run.
@item datafile = @var{FILENAME} @item datafile = @var{FILENAME}
@xref{datafile}. Useful when computing the shock decomposition on a @xref{datafile_shock_decomp}.
calibrated model.
@item first_obs = @var{INTEGER} @item first_obs = @var{INTEGER}
@xref{first_obs}. @xref{first_obs}.
@ -7219,14 +7208,11 @@ calibrated model.
@item nobs = @var{INTEGER} @item nobs = @var{INTEGER}
@xref{nobs}. @xref{nobs}.
@item use_shock_groups [= @var{SHOCK_GROUPS_NAME}] @item use_shock_groups [= @var{STRING}]
@anchor{use_shock_groups_realtime} Uses groups of shocks instead of individual @xref{use_shock_groups}.
shocks in the decomposition. Groups of shocks are defined in the
@ref{shock_groups} block.
@item colormap = @var{COLORMAP_NAME} @item colormap = @var{STRING}
@anchor{colormap_realtime} Controls the colormap used for the shocks @xref{colormap}.
decomposition graphs. See @code{colormap} in Matlab/Octave manual.
@item nograph @item nograph
@xref{nograph}. Only shock decompositions are computed and stored in @code{oo_.realtime_shock_decomposition}, @xref{nograph}. Only shock decompositions are computed and stored in @code{oo_.realtime_shock_decomposition},
@ -7296,19 +7282,17 @@ Note that this command must come after @code{shock_decomposition} or @code{realt
@table @code @table @code
@item use_shock_groups [= @var{SHOCK_GROUPS_NAME}] @item use_shock_groups [= @var{STRING}]
@anchor{use_shock_groups_plot} Uses groups of shocks instead of individual @xref{use_shock_groups}.
shocks in the decomposition. Groups of shocks are defined in the
@ref{shock_groups} block.
@item colormap = @var{COLORMAP_NAME} @item colormap = @var{STRING}
@anchor{colormap_plot} Controls the colormap used for the shocks decomposition @xref{colormap}.
graphs. See @code{colormap} in Matlab/Octave manual.
@item nodisplay @item nodisplay
@xref{nodisplay}. @xref{nodisplay}.
@item graph_format = (@var{GRAPH_FORMAT_LIST}) @item graph_format = @var{FORMAT}
@itemx graph_format = ( @var{FORMAT}, @var{FORMAT}@dots{} )
@xref{graph_format}. @xref{graph_format}.
@item detail_plot @item detail_plot
@ -7328,15 +7312,14 @@ by the mean absolute value of all historical contributions.
zero line in the shock decomposition plot is translated to the steady state zero line in the shock decomposition plot is translated to the steady state
level. Default: @math{0} level. Default: @math{0}
@item type = @var{TYPE_NAME} @item type = @code{qoq} | @code{yoy} | @code{aoa}
@anchor{type} For quarterly data, @var{TYPE_NAME} can take one of the @anchor{type} For quarterly data, valid arguments are: @code{qoq} for
following values: @code{qoq} for quarter-on-quarter plots, @code{yoy} for quarter-on-quarter plots, @code{yoy} for year-on-year plots of growth rates,
year-on-year plots of growth rates, @code{aoa} for annualized variables, @code{aoa} for annualized variables, @i{i.e.} the value in the last quarter for
@i{i.e.} the value in the last quarter for each year is plotted. Default each year is plotted. Default value: @code{empty}, @i{i.e.} standard
value: @code{empty}, @i{i.e.} standard period-on-period plots (@code{qoq} for period-on-period plots (@code{qoq} for quarterly data).
quarterly data).
@item fig_name = @var{FIG_NAME} @item fig_name = @var{STRING}
@anchor{fig_name} Specifies a user-defined keyword to be appended to the @anchor{fig_name} Specifies a user-defined keyword to be appended to the
default figure name set by @code{plot_shock_decomposition}. This can avoid to default figure name set by @code{plot_shock_decomposition}. This can avoid to
overwrite plots in case of sequential calls to @code{plot_shock_decomposition}. overwrite plots in case of sequential calls to @code{plot_shock_decomposition}.