setcollabels

Purpose

Set categorical variable labels.

Format

x_cat = setColLabels(X, labels, values, columns)
Parameters:
  • X (NxK matrix or dataframe) – data.
  • labels (Mx1 string array) – Names or indices of the categorical variables in X to set labels for.
  • values (Mx1 vector) – Values to assign labels to.
  • columns (scalar or string) – Variables to assign the labels to.
Returns:

x_cat (NxK dataframe) – Contains metadata assigning the categorical labels in labels to values specified in values for the variable specified by columns.

Examples

x = { 3,
      2,
      0,
      4,
      2,
      1 };

// Define labels
labels = "poor"$|"fair"$|"average"$|"good"$|"excellent";

/*
** Set labels
*/

key_vals = { 0, 1, 2, 3, 4 };

// Note that this makes 'x_cat' a dataframe
// with a single categorical column
x_cat = setColLabels(x, labels, key_vals, 1);

print x_cat;

The code above prints the following:

       X1
     good
  average
     poor
excellent
  average
     fair