indices2#

Purpose#

Processes two sets of variable names or indices from a single file. The first is a single variable and the second is a set of variables. The first must not occur in the second set and all must be in the file.

Format#

{ name1, indx1, name2, indx2 } = indices2(dataset, var1, var2)#
Parameters:

  • dataset (string) – the name of the dataset.

  • var1 (string or scalar) –

    variable name or index.

    This can be either the name of the variable, or the column index of the variable.

    If null or 0, the last variable in the dataset will be used.

  • var2 (Nx1 vector) – a character vector of names or a numeric vector of column indices. If scalar 0, all variables in the dataset except the one associated with var1 will be selected.

Returns:

  • name1 (scalar character matrix) – the name of the variable associated with var1.

  • indx1 (scalar) – the column index of var1.

  • name2 (Nx1 character vector) – the names associated with var2.

  • indx2 (Nx1 numeric vector) – the column indices of the variables in var2.

Examples#

// Create filename
filename = getGAUSSHome("examples/auto.dat");

// Get variable names
var1 = "mpg";
var2 = "weight";

// Get indices and names of variables
{name1, indx1, name2, indx2 } = indices2(filename, "mpg", "weight");

// Print variable one name
print "Variable 1 name:" $name1;

// Print index for variable one
print "Variable 1 index:" indx1;

// Print variable two name
print "Variable 2 name:" $name2;

// Print index for variable two
print "Variable 2 index" indx2;

This produces the following output:

Variable 1 name:             mpg
Variable 1 index:       3.0000000
Variable 2 name:          weight
Variable 2 index       7.0000000

Remarks#

If an error occurs, indices2() will either return a scalar error code or terminate the program with an error message, depending on the trap state. If the low order bit of the trap flag is 0, indices2() will terminate with an error message. If the low order bit of the trap flag is 1, indices2() will return an error code. The value of the trap flag can be tested with trapchk; the return from indices2() can be tested with scalerr(). You only need to check one argument; they will all be the same. The following error codes are possible:

1

Can’t open dataset.

2

Index of variable out of range, or undefined data set variables.

3

First variable must be a single name or index.

4

First variable contained in second set.

Source#

indices2.src

On this page
Show Source