Syntax | Binomial 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 (
  'binomialtest',
  'required_parameter_list [ optional_parameter; [...] ]'
);
required_parameter_list
database = input_database_name;
tablename = input_table_name;
firstcolumn = column_name;
secondcolumn = column_name;
optional_parameter
{ binomialprobability = binomial_prob |
  exactmatches = exact_matches |
  fallback = { true | false } |
  gensqlonly = { true | false } |
  groupby = column_name [,...] |
  multiset = { true | false } |
  outputdatabase = output_database_name |
  outputtablename = output_table_name |
  overwrite = { true | false } |
  singletail = { true | false } |
  statsdatabase = stats_database_name |
  teststyle = { binomial | sign } |
  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.
firstcolumn
The column to analyze. It must reside in the table indicated by the tablename parameter.
binomialprobability
[Optional] The binomial probability.
Disallowed with teststyle=sign.
Default: 0.5
exactmatches
[Optional] How to handle exact matches:
exact_matches Description
0 Discard exact match.
Positive Put exact match with values greater than or equal to zero.
Negative (default) Put exact match with values less than or equal to zero.
Disallowed with teststyle=sign.
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.
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.
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.
secondcolumn
[Optional] The second column to analyze.
Required with teststyle=binomial.
Disallowed with teststyle=sign.
singletail
[Optional] Whether the test is single-tailed.
Specify true only with binomialprobability=0.5.
Default: false (test is two-tailed)
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] Binomial test or sign test.
Default: binomial
thresholdprobability
[Optional] The threshold (alpha) probability, below which the null hypothesis is rejected.
Default: 0.05