Syntax | Factor Analysis | Vantage Analytics Library - Syntax - Vantage Analytics Library

Vantage Analytics Library User Guide

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Vantage Analytics Library
Release Number
2.2.0
Published
March 2023
Language
English (United States)
Last Update
2024-01-02
dita:mapPath
ibw1595473364329.ditamap
dita:ditavalPath
iup1603985291876.ditaval
dita:id
zyl1473786378775
Product Category
Teradata Vantage
CALL td_analyze (
  'factor',
  'required_parameter_list [ optional_parameter; [...] ]'
);
required_parameter_list
database = input_database_name;
tablename = input_table_name;
columns = { all | column_name [,...] };
optional_parameter
{ columnstoexclude = column_name [,...] |
  conditionindexthreshold = threshold |
  eigenmin = min_eigenvalue |
  { factorloadingsreport | flr } = { true | false } |
  { factorvariablesloadingsreport | fvlr } = { true | false } |
  { factorvariablesreport | fvr } = { true | false } |
  gamma = gamma |
  groupby = column_name [,...] |
  matrixinput = { true | false } |
  matrixtype = { correlation | covariance } |
  neardependencyreport = { true | false } |
  numfactors = num_factors |
  outputdatabase = output_database_name |
  outputtablename = output_table_name |
  overwrite = { true | false } |
  rotationtype = { none | rotation_type } |
  thresholdloading = threshold_loading |
  thresholdpercent = threshold_percent |
  varianceproportionthreshold = threshold
}

Syntax Elements

database
The database containing the input table.
tablename
The input table from which to build a factor model.
columns
The columns to analyze.
keyword Description
all All columns.
allnumeric All numeric columns.
columnstoexclude
[Optional] The columns to exclude when columns specifies a keyword.
Any groupby columns are automatically excluded.
conditionindexthreshold
[Optional] One of two thresholds for neardependencyreport.
Default: 30
eigenmin
[Optional] The minimum eigenvalue for which to include factors.
Specify either eigenmin or numfactors.
Default: 1.0
flr
factorloadingsreport
[Optional] Whether to output the Prime Factor Loadings Report, where rows are variables and columns are factors. The report matches each variable with the factor that has the largest absolute loading value.
Default: false
fvlr
factorvariablesloadingsreport
[Optional] Whether to output the Prime Factor Variables with Loadings Report, which is equivalent to the Prime Factor Variables Report with the loading values that determined the relationship between factors and variables. The absolute sizes of the loading values show the relationship strength and a positive or negative correlation.
Default: false
fvr
factorvariablesreport
[Optional] Whether to output the Prime Factor Variables Report, in which rows are variables and columns are factors. The report matches variables with their prime factors, and possibly with other factors if you specify the thresholdpercent or thresholdloading parameter.
Default: false
gamma
[Optional] Gamma value to use with rotationtype=orthomax or rotationtype=orthomin.
Gamma is only available for use with orthomax and orthomin.
groupby
[Optional] The input table columns for which to separately analyze each value or combination of values.
Default behavior: Input is not grouped.
matrixinput
[Optional] Whether the input table located by database and tablename represents an ESSCP matrix built by the Matrix Building function and saved to a table.
If the input table represents a saved matrix and you do not specify matrixinput=true, the function may interpret the matrix an ordinary table, causing unpredictable results.
When the function uses a saved ESSCP matrix as the input table, it does not have to build the matrix each time it is called, providing a significant performance improvement.
If matrixinput=true, these rules apply to the columns that columns specifies:
  • They must appear in the matrix.
  • They can be a subset of the columns in the matrix.
  • columns can specify them in any order.
If the matrix specifies groupby columns, the function must specify the same columns with groupby.
Default: false
matrixtype
[Optional] The type of matrix for processing, which affects measure and score scaling.
Default: correlation
neardependencyreport
[Optional] Whether to output an XML report showing columns that may be collinear and store it in the XML output table if all these conditions are true:
  • You specify outputdatabase and outputtablename.
  • The thresholds conditionindexthreshold and varianceproportionthresholdspecify are crossed.
  • The function detects collinearity.
The same report is available for Factor Analysis, Linear Regression and Logistic Regression.
Default: false
numfactors
[Optional] The number of factors to retain in the solution.
Specify either eigenmin or numfactors.
outputdatabase
[Optional] The database that contains the output table that represents one or more factor models.
If you do not specify both outputdatabase and outputtablename, the function creates a volatile output table with a randomly generated name in the logon user database.
outputtablename
[Optional] The name of the output table representing one or more logistic models (see groupby).
If you do not specify both outputdatabase and outputtablename, the function creates volatile output tables with randomly generated names in the logon user database and returns a result set.
overwrite
[Optional] Whether to drop the output tables before creating new ones.
Default: true
rotationtype
[Optional] The rotation type, which is either none or a rotationtype from the following table.
rotationtype Gamma Value Orthogonal/Oblique Notes
equamax f / 2 Orthogonal  
orthomax Set by user  
parsimax v (f - 1) / v + f + 2)  
quartimax 0.0  
varimax 1.0  
biquartimin 0.5 Oblique  
covarimin 2.0 Least oblique rotation
orthomin Set by user  
quartimin 0.0 Most oblique rotation
In the gamma value equations for equamax and parsimax, f is the number of factors and v is the number of variables. For orthomax and orthomin, you set the gamma value with the td_analyze gamma parameter.
Default: none
thresholdloading
[Optional] A threshold that may associate a variable with a factor other than a prime factor in the Prime Factor Variables Report if factorvariablesreport=true.
Specify either factorvariablesreport or thresholdpercent but not both.
thresholdpercent
[Optional] A threshold percent which, if less than 1.0, may associate a variable with a factor other than a prime factor in the Prime Factor Variables Report if factorvariablesreport=true.
Specify either factorvariablesreport or thresholdpercent but not both.
varianceproportionthreshold
[Optional] One of two thresholds for neardependencyreport.
Default: 0.5