9. Dynare misc commands

MATLAB/Octave command: internals FLAG ROUTINENAME[.m]|MODFILENAME

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 state of Dynare.

Flags

--test

Performs the unitary test associated to ROUTINENAME (if this routine exists and if the matalab/octave m file has unitary test sections). Example

>> internals --test ROUTINENAME

if routine.m is not in the current directory, the full path has to be given:

>> internals --test ../matlab/fr/ROUTINENAME

--info

Prints on screen the internal documentation of ROUTINENAME (if this routine exists and if this routine has a texinfo internal documentation header). The path to ROUTINENAME has to be provided, if the routine is not in the current directory. Example

>> internals --doc ../matlab/fr/ROUTINENAME

At this time, will work properly for only a small number of routines. At the top of the (available) Matlab/Octave routines a commented block for the internal documentation is written in the GNU texinfo documentation format. This block is processed by calling texinfo from MATLAB. Consequently, texinfo has to be installed on your machine.

--display-mh-history

Displays information about the previously saved MCMC draws generated by a mod file named MODFILENAME. This file must be in the current directory. Example

>> internals --display-mh-history MODFILENAME

--load-mh-history

Loads into the Matlab/Octave’s workspace informations about the previously saved MCMC draws generated by a mod file named MODFILENAME. Example

>> internals --load-mh-history MODFILENAME

This will create a structure called mcmc_informations (in the workspace) with the following fields:

Nblck

The number of MCMC chains.

InitialParameters

A Nblck*n, where n is the number of estimated parameters, array of doubles. Initial state of the MCMC.

LastParameters

A Nblck*n, where n is the number of estimated parameters, array of doubles. Current state of the MCMC.

InitialLogPost

A Nblck*1 array of doubles. Initial value of the posterior kernel.

LastLogPost

A Nblck*1 array of doubles. Current value of the posterior kernel.

InitialSeeds

A 1*Nblck structure array. Initial state of the random number generator.

LastSeeds

A 1*Nblck structure array. Current state of the random number generator.

AcceptanceRatio

A 1*Nblck array of doubles. Current acceptance ratios.

This document was generated by Build Daemon user on December 8, 2015 using texi2html 1.82.