Optional Parameters - Teradata Warehouse Miner

outputdatabase

The database that contains the resulting matrix output table.

If outputdatabase and outputtablename are not both specified, a volatile output table with randomly generated name is created in the logon userdatabase and the results are returned to the user in a result data set.

outputtablename

The name of the output table representing one or more matrices. If group by columns are specified, there is a matrix for each combination of group by column values.

Note that the output table must first be dropped by the user before executing the function if outputdatabase and outputtablename are both specified. If outputdatabase and outputtablename are not both specified, a volatile output table with randomly generated name is created in the logon userdatabase, and the result set is returned to the user instead.

matrixtype

The following types of matrix can be built with this function. If not specified, a sum-of-squares-and-cross-products (SSCP) matrix is built.

• SSCP = sum-of-squares-and-cross-products matrix (the default)
• ESSCP = Extended-sum-of-squares-and-cross-products matrix
• CSSCP = Corrected-sum-of-squares-and-cross-products matrix
• COV = Covariance matrix
• COR = Correlation matrix

where

An optional conditional expression may be specified with this parameter, limiting the amount of data used to build the matrix.

For example: where=income>0

groupby

If specified, group by columns divide the input table into parts, one for each combination of values in the group by columns. For each combination of values a separate matrix is built, though they are all stored in the same output table or result data set. The group by columns must reside in the table named with the tablename parameter. The default case is no group by columns.

For example: groupby=column1,column2,column3

nullhandling {ZERO|IGNORE}

If a value in a selected column is NULL, the row that contains the NULL value is by default omitted from processing (nullhandling=IGNORE), or the value may be replaced in calculations with zero through the use of this parameter (nullhandling=ZERO).

matrixoutput {COLUMNS|VARBYTE}

Matrix output can either be returned as COLUMNS in a table or as VARBYTE values, one per column, in a reduced output table. The default is output returned as COLUMNS.