*! version 1.0.1 21aug2026

Title

gvar describe -- what is in memory, and the order of x(t)

Syntax

gvar describe [, order varlist nosummary]

options

order print the numbered order of x(t).

varlist print each unit's domestic and weakly exogenous blocks.

nosummary suppress the per-unit table.

Description

gvar describe reports the dimensions of the model, how far through the
workflow you are, the per-unit specification grid and, with order, the
numbered ordering of the global vector x(t).

That ordering is not cosmetic. It is the Cholesky ordering used by
type(oirf) and the block boundary used by type(sgirf) in
gvar irf, so every orthogonalised result depends on it.

Options

order prints the order of the global vector x_t -- which element is
which. Read it before writing any shock() or variables()
specification, and before interpreting any matrix returned in r(): the row
order of everything in the package is this order.

varlist lists each unit's domestic block, foreign block and lag orders,
including the blanks. A unit that lacks a long rate has no lr and no
lr* anywhere downstream, and this is where you confirm that is intended
rather than a name that failed to match.

stats adds summary statistics per series.

nosummary suppresses the header.

Remarks

The specification table reports k and k*, the lag orders p and
q, the deterministic case, the cointegrating rank and, once estimated,
the log likelihood. The footer gives the total rank and the implied number of
unit roots, K - sum r_i, which gvar solve checks
against the eigenvalues of the companion matrix.

Changing the ordering. You do not reorder the data. Use first() and
vorder() on gvar irf, gvar fevd,
gvar spillover or gvar hd: those permute
the system internally and map the results back to the model's own order before
reporting, so the rows you read are always in the order printed here.

Examples

. gvar describe
. gvar describe, order
. gvar describe, order varlist

Stored results

gvar describe stores the following in r():

r(N) units

r(K) endogenous variables

r(T) periods

r(units) unit names

r(domestic) domestic variable names

r(global) global variable names

r(estimated) 1 if the country models are estimated

r(solved) 1 if the GVAR is solved

Source

Reporting command. The grid it prints is the Toolbox's
dvflag/fvflag/gvflag specification.

Author

Dr Merwan Roudane

merwanroudane920@gmail.com

https://github.com/merwanroudane