Syntax | Kolmogorov-Smirnov Tests | Vantage Analytics Library - Syntax - Vantage Analytics Library

Vantage Analytics Library User Guide

Deployment
VantageCloud
VantageCore
Edition
VMware
Enterprise
IntelliFlex
Lake
Product
Vantage Analytics Library
Release Number
2.2.0
Published
June 2025
ft:locale
en-US
ft:lastEdition
2025-07-02
dita:mapPath
ibw1595473364329.ditamap
dita:ditavalPath
iup1603985291876.ditaval
dita:id
zyl1473786378775
Product Category
Teradata Vantage
CALL td_analyze (
  'kstest',
  'required_parameter_list [ optional_parameter; [...] ]'
);
required_parameter_list
database = input_database_name;
tablename = input_table_name;
columnofinterest = column_name;
optional_parameter
{ columns = column_name, column_name |
  fallback = { true | false } |
  gensqlonly = { true | false } |
  groupby = column_name [,...] |
  multiset = { true | false } |
  outputdatabase = output_database_name |
  outputtablename = output_table_name |
  overwrite = { true | false } |
  statsdatabase = stats_database_name |
  teststyle = { ks | l | sw | p | s } |
  thresholdprobability = threshold_prob
}

Syntax Elements

database
The database containing the table to analyze.
tablename
The table containing the columns to analyze. It must reside in the database indicated by the database parameter.
columnofinterest
A numeric input table column whose values have a normal distribution. It must reside in the table indicated by the tablename parameter.
columns
[Optional] Only if teststyle=ks, the input table column that represents a categorical variable with two values that indicate the distribution to which the columnofinterest belongs.
fallback
[Optional] Whether to give the output table the FALLBACK attribute.
Default: false
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.
Parameter not valid when teststyle=s.
Default: false
groupby
[Optional] The input table columns for which to separately analyze each value or combination of values.
Default behavior: Input is not grouped.
When teststyle=s, the groupby parameter is limited by one groupby column or none.
multiset
[Optional] Whether to give the output table the MULTISET attribute.
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
statsdatabase
[Optional] The database where the statistical test metadata tables are installed.
Default behavior: The function searches the source database for these tables.
teststyle
[Optional] The test style, which is one of the following:
Option Test Style
ks (default) Kolmogorov-Smirnov
l Lilliefors
sw Shapiro-Wilk
p D'Agostino and Pearson
s Smirnov
thresholdprobability
[Optional] The threshold (alpha) probability, below which the null hypothesis is rejected.
Default: 0.05