Verified Commit b4479361 authored by Houtan Bastani's avatar Houtan Bastani
Browse files

doc: fix typo and formatting

parent 8fbb7730
...@@ -167,24 +167,26 @@ Dynare misc commands ...@@ -167,24 +167,26 @@ Dynare misc commands
A ``1*Nblck`` array of doubles. Current acceptance ratios. A ``1*Nblck`` array of doubles. Current acceptance ratios.
.. matcomm:: prior [options[, ...]]; .. matcomm:: prior [OPTIONS[, ...]];
Prints various informations about the prior distribution depending Prints information about the prior distribution given the provided
on the options. If no options are provided, the command returns options. If no options are provided, the command returns the list of
the list of available options. Following options are available: available options.
``table`` *Options*
.. option:: table
Prints a table describing the marginal prior distributions Prints a table describing the marginal prior distributions
(mean, mode, std., lower and upper bounds, HPD interval). (mean, mode, std., lower and upper bounds, HPD interval).
``moments`` .. option:: moments
Computes and displays first and second order moments of the Computes and displays first and second order moments of the
endogenous variables at the prior mode (considering the endogenous variables at the prior mode (considering the
linearized version of the model). linearized version of the model).
``moments(distribution)`` .. option:: moments(distribution)
Computes and displays the prior mean and prior standard Computes and displays the prior mean and prior standard
deviation of the first and second moments of the endogenous deviation of the first and second moments of the endogenous
...@@ -193,7 +195,7 @@ Dynare misc commands ...@@ -193,7 +195,7 @@ Dynare misc commands
stored in the ``prior`` subfolder in a stored in the ``prior`` subfolder in a
``_endogenous_variables_prior_draws.mat`` file. ``_endogenous_variables_prior_draws.mat`` file.
``optimize`` .. option:: optimize
Optimizes the prior density (starting from a random initial Optimizes the prior density (starting from a random initial
guess). The parameters such that the steady state does not guess). The parameters such that the steady state does not
...@@ -203,7 +205,7 @@ Dynare misc commands ...@@ -203,7 +205,7 @@ Dynare misc commands
defined over such regions, the optimization algorithm may fail defined over such regions, the optimization algorithm may fail
to converge to the true solution (the prior mode). to converge to the true solution (the prior mode).
``simulate`` .. option:: simulate
Computes the effective prior mass using a Monte-Carlo. Ideally Computes the effective prior mass using a Monte-Carlo. Ideally
the effective prior mass should be equal to 1, otherwise the effective prior mass should be equal to 1, otherwise
...@@ -215,6 +217,6 @@ Dynare misc commands ...@@ -215,6 +217,6 @@ Dynare misc commands
:math:`p_A\neq p_B \leq 1` so that the prior mass of the :math:`p_A\neq p_B \leq 1` so that the prior mass of the
compared models are identical. compared models are identical.
``plot`` .. option:: plot
Plots the marginal prior density. Plots the marginal prior density.
...@@ -7974,7 +7974,7 @@ The forecast scenario can contain some simple shocks on the exogenous ...@@ -7974,7 +7974,7 @@ The forecast scenario can contain some simple shocks on the exogenous
variables. This shocks are described using the function variables. This shocks are described using the function
``basic_plan``: ``basic_plan``:
.. matcomm:: HANDLE = basic_plan (HANDLE, 'VAR_NAME', 'SHOCK_TYPE', DATES, MATLAB VECTOR OF DOUBLE | [DOUBLE | EXPR [DOUBLE | | EXPR] ] ); .. matcomm:: HANDLE = basic_plan (HANDLE, `VAR_NAME', `SHOCK_TYPE', DATES, MATLAB VECTOR OF DOUBLE | [DOUBLE | EXPR [DOUBLE | EXPR] ] );
Adds to the forecast scenario a shock on the exogenous variable Adds to the forecast scenario a shock on the exogenous variable
indicated between quotes in the second argument. The shock type indicated between quotes in the second argument. The shock type
...@@ -7992,7 +7992,7 @@ compatible with the constrained path are in this case computed. In ...@@ -7992,7 +7992,7 @@ compatible with the constrained path are in this case computed. In
other words, a conditional forecast is performed. This kind of shock other words, a conditional forecast is performed. This kind of shock
is described with the function ``flip_plan``: is described with the function ``flip_plan``:
.. matcomm:: HANDLE = flip_plan (HANDLE, 'VAR_NAME, 'VAR_NAME', 'SHOCK_TYPE', DATES, MATLAB VECTOR OF DOUBLE | [DOUBLE | EXPR [DOUBLE | | EXPR] ] ); .. matcomm:: HANDLE = flip_plan (HANDLE, `VAR_NAME', `VAR_NAME', `SHOCK_TYPE', DATES, MATLAB VECTOR OF DOUBLE | [DOUBLE | EXPR [DOUBLE | EXPR] ] );
Adds to the forecast scenario a constrained path on the endogenous Adds to the forecast scenario a constrained path on the endogenous
variable specified between quotes in the second argument. The variable specified between quotes in the second argument. The
...@@ -8049,7 +8049,8 @@ computed with the command ``det_cond_forecast``: ...@@ -8049,7 +8049,8 @@ computed with the command ``det_cond_forecast``:
plot(dset_forecast.{'r','e'}); plot(dset_forecast.{'r','e'});
.. command:: smoother2histval [(OPTIONS...)]; .. command:: smoother2histval ;
smoother2histval(OPTIONS...);
The purpose of this command is to construct initial conditions The purpose of this command is to construct initial conditions
(for a subsequent simulation) that are the smoothed values of a (for a subsequent simulation) that are the smoothed values of a
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment