DOC

<< Click to Display Table of Contents >>

Navigation:  Gekko commands >

DOC

Previous pageReturn to chapter overviewNext page

The command is used to 'manually' change meta information fields in a timeseries.

 

The meta information is shown in the DISP command.

 

 


 

Syntax

 

DOC  variables  LABEL=...  SOURCE=... UNITS=... STAMP=... ;

DOC <browser>;

 

variables

Variablename(s) or list(s) (wild-cards are allowed). You may prepend a databank name as bank:variable.

LABEL=

(Optional). Changes the label of the timeseries. You may use LABEL='' to clear.

SOURCE=

(Optional). Changes the source of the timeseries. You may use SOURCE='' to clear.

UNITS=

(Optional). Changes the units of the timeseries. You may use UNITS='' to clear.

STAMP=

(Optional). Changes the stamp of the timeseries. You may use STAMP='' to clear.

 

If a variable is stated without databank, the databank is assumed to be the first-position databank.

 

DOC <browser> produces a stand-alone equation browser in html, which can, for instance, be put on a web server. The produces system is independent of Gekko and shows variables, formulas, labels, graphs, estimation output, data, etc. This inner workings of this system will be documented later on, if needed before then, please contact the Gekko editor. Essentially the system replicates how DISP can show equations etc. from inside Gekko.

 

 


 

Examples

 

To change label, source and stamp on the timeseries fY, use:

 

DOC fY label='Gdp' source='Statistics Denmark'  stamp='11-01-2015';

 

To clear the label, use an empty string:

 

DOC fy label='';

 

 


 

Note

 

Meta information like this is read from and written to .gbk or .tsd files.

 

Regarding meta-information on timeseries, you may set these directly when defining the series, for instance <label = 'Value added tax'> vat = 0.25;.

 

 


 

Related commands

 

READ, IMPORT, WRITE, EXPORT, DISP