Document new search matlab command.

silicon
Stéphane Adjemian (Ryûk) 2023-03-05 18:08:41 +01:00
parent ae085b9add
commit a9ee96d441
Signed by: stepan
GPG Key ID: 295C1FE89E17EB3C
1 changed files with 91 additions and 51 deletions

View File

@ -10,7 +10,7 @@ Dynare misc commands
.. command:: prior_function(OPTIONS);
|br| Executes a user-defined function on parameter draws from the prior
Executes a user-defined function on parameter draws from the prior
distribution. Dynare returns the results of the computations for
all draws in an $ndraws$ by $n$ cell array named
``oo_.prior_function_results``.
@ -30,9 +30,11 @@ Dynare misc commands
Number of draws used for sampling. Default: 500.
|br|
.. command:: posterior_function(OPTIONS);
|br| Same as the :comm:`prior_function` command but for the
Same as the :comm:`prior_function` command but for the
posterior distribution. Results returned in
``oo_.posterior_function_results``.
@ -46,15 +48,19 @@ Dynare misc commands
See :opt:`prior_function_sampling_draws <sampling_draws = INTEGER>`.
|br|
.. command:: generate_trace_plots(CHAIN_NUMBER);
|br| Generates trace plots of the MCMC draws for all estimated
Generates trace plots of the MCMC draws for all estimated
parameters and the posterior density in the specified Markov Chain
``CHAIN_NUMBER``.
|br|
.. matcomm:: internals FLAG ROUTINENAME[.m]|MODFILENAME
|br| Depending on the value of ``FLAG``, the ``internals`` command
Depending on the value of ``FLAG``, the ``internals`` command
can be used to run unitary tests specific to a MATLAB/Octave
routine (if available), to display documentation about a
MATLAB/Octave routine, or to extract some informations about the
@ -93,7 +99,7 @@ Dynare misc commands
``--load-mh-history``
|br| Loads into the MATLAB/Octaves workspace informations
Loads into the MATLAB/Octaves workspace informations
about the previously saved MCMC draws generated by a ``.mod``
file named MODFILENAME.
@ -146,6 +152,8 @@ Dynare misc commands
A ``1*Nblck`` array of doubles. Current acceptance ratios.
|br|
.. matcomm:: prior [OPTIONS[, ...]];
Prints information about the prior distribution given the provided
@ -199,3 +207,35 @@ Dynare misc commands
.. option:: plot
Plots the marginal prior density.
|br|
.. matcomm:: search VARIABLENAME[ OPTION]
Searches all occurrences of a variable in a model, and prints the
equations where the variable appear in the command line window. If OPTION is
set to `withparamvalues`, the values of the parameters (if available) are
displayed instead of the name of the parameters.
*Example*
Assuming that we already ran a `.mod` file and that the workspace has not
been cleaned after, we can search for all the equations containing variable `X`
::
>> search X
Y = alpha*X/(1-X)+e;
diff(X) = beta*(X(-1)-mX) + gamma1*Z + gamma2*R + u;
To replace the parameters with estimated or calibrated parameters:
::
>> search X withparamvalues
Y = 1.254634*X/(1-X)+e;
diff(X) = -0.031459*(X(-1)-mX) + 0.1*Z - 0.2*R + u;