xlsWriteSA

Purpose

Writes a GAUSS string or string array to an Excel® spreadsheet.

Format

ret = xlsWriteSA(data[, file[, range[, sheet[, vls]]]])
Parameters:
  • data (string or string array) – data to write.
  • file (string) – name of .xls, or xlsx file.
  • range (string) – the starting point of the write, e.g. “a2”. Default = “a1”.
  • sheet (scalar) – sheet number. Default = 1.
  • vls (null string or 9x1 string array) – specifies the conversion of GAUSS characters into Excel® empty cells and special types (see Remarks). A null string results in all null strings being converted to empty cells. Default = null string.
Returns:

ret (scalar) – 0 if success or a scalar error code.

Portability

Windows, Linux and macOS.

The vls input is currently ignored on macOS and Linux.

Examples

Basic Example

// Create a 1x3 string array of variable names
var_names = "Date" $~  "Price" $~ "Volume";

// Write contents of 'var_names' to 'myfile.xlsx'
// from cell 'A1' to 'C1'
ret = xlsWriteSA(var_names, "myfile.xlsx");

myfile.xlsx is saved in your current working directory. You can find your current working directory in the main tool bar (in the top of GAUSS).

Write To a Range

// Create a 1x4 string array of variable names
head = "Real GDP" $~  "Unemployment" $~ "CPI" $~ "PPI";

// Write the variable names to the cells 'C1:F1'
ret = xlsWriteSA(head, "myfile.xlsx", "C1");

Specify Path and Sheet Number

// Create a 3x1 string array
labels = "Normotensive" $|  "Hypertensive" $| "Hypotensive";

// Write the data from 'labels' to cells 'D7:D9' on sheet 2 of 'myfile.xlsx'
ret = xlsWriteSA(labels, "C:/mydata/myfile.xlsx", "D7", 2);

Remarks

  1. To write a dataset with numeric variables and header names to an Excel file, use saved().

  2. The vls argument lets users control the export to Excel® empty cells and special types, according to the following table:

    Row Number Excel® Cell
    1 empty cell
    2 #N/A
    3 #VALUE!
    4 #DIV/0!
    5 #NAME?
    6 #REF!
    7 #NUM!
    8 #NULL!
    9 #ERR

    Use the following to convert all occurrences of “Division by Zero” to #DIV/0!, and all null strings to empty cells:

    vls = reshape("",9,1);
    vls[4] = "Division by Zero";
    
  3. If xlsWriteSA() fails, it will either terminate and print an error message or return a scalar error code, which can be decoded with scalerr(), depending on the state of the trap flag.

    trap 0 Print error message and terminate program.
    trap 1 Return scalar error code which can be checked for with scalmiss().