gdaReportVarInfo

Purpose

Gets information about all of the variables in a GAUSS Data Archive and returns it in a string array formatted for printing.

Format

vinfo = gdaReportVarInfo(filename)

Parameters:

filename (string) – name of data file.

Returns:

vinfo (Nx1 string array) – containing variable information.

Examples

// Generate random variable x1
x1 = rndn(100, 50);

// Generate random variable x2
x2 = rndn(75, 5);

// Generate array a
a = areshape(rndn(10000, 1), 10|100|10);

// Create GDA named `myfile`
fname = "myfile.gda";
ret = gdaCreate(fname, 1);

/*
** Write variables x1, x2, and
** a to `myFile`
*/
ret = gdaWrite(fname, x1, "x1");
ret = gdaWrite(fname, x2, "x2");
ret = gdaWrite(fname, a, "a1");

// Report information about variables
gdaReportVarInfo(fname);

produces:

Index Name Type cOrders
  1   x1  matrix 100x50
  2   x2  matrix 75x5
  3   a1  array 10x100x10

Remarks

If you just want to print the information to the window, call gdaReportVarInfo() without assigning the output to a symbol name:

gdaReportVarInfo(filename);

Source

gdafns.src

See also

Functions gdaGetVarInfo(), gdaGetNames(), gdaGetTypes(), gdaGetOrders()