Syntax | Reports | Vantage Analytics Library - Syntax - Vantage Analytics Library

CALL td_analyze (
  'report',
  'required_parameter_list [ optional_parameter; [...] ]'
);

required_parameter_list

database = input_database_name;
tablename = input_table_name;
analysistype = function_name;

optional_parameter

{ gensqlonly = { true | false } |
  outputdatabase = output_database_name |
  outputtablename = output_table_name |
  overwrite = { true | false } |
  where = expression [,...]
}

Syntax Elements

database

The database containing the input table.

tablename

The name of the input table for the report function, output by the function specified by analysistype—either the main output table or an output table whose name ends in "_txt" or "_rpt".

If you specify the main output table, the report function determines which table contains the XML column. An output table whose name ends in "_txt" or "_rpt" must contain the XML column.

analysistype

The name of the function whose XML you want the report function to translate to HTML.

The report function outputs the HTML reports listed in the second column of the following table.

Function (function_name)	HTML Reports
decisiontree	Decision Tree Summary Variables Text Tree
decisiontreescore	Decision Tree Scoring Summary—Confusion Matrix
factor	Factor Analysis Summary Variable Statistics Eigenvalues PCLoadings Variance and Absolute Difference Near Dependency Report Group-by Columns
factorscore	Factor Analysis Scoring Summary
linear	Linear Regression Summary Group-by Columns Near Dependency Report
logistic	Prediction Success Table Multithreshold Success Table Lift Table Near Dependency Report Group-by Columns Variable Statistics
logisticscore	Prediction Success Table Multithreshold Success Table Lift Table

gensqlonly

[Optional] True returns the SQL for the function as a result set but does not run it.

False runs the SQL for the function but does not return it as a result set.

Default: false

outputdatabase

[Optional] The name of the database to contain the analysis results table.

outputtablename

[Optional] The name of the table to store the analysis results.

Default behavior: Function returns results as a result set but does not create an output table.

overwrite

[Optional] Whether to drop the output tables before creating new ones.

Default: true

where

[Optional] The expression in the SQL WHERE clause to include in the generated SQL to filter rows selected for analysis.

Examples:

• where = cust_id > 0 includes this WHERE clause in the generated SQL:

  WHERE cust_id > 0

• where = gender = ''F'' includes this WHERE clause in the generated SQL:

  WHERE gender='F'

This parameter is useful only when the function analysis_type (which output the input_table_name for the report function) specified its groupby parameter and generated multiple XML models.

Multiple XML models in input_table_name can cause the report function to run out of memory. In that case, limit the rows selected for analysis with a WHERE clause.