Syntax | Parametric Tests | Vantage Analytics Library - Syntax - Vantage Analytics Library

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

required_parameter_list

database = input_database_name;
tablename = input_table_name;

optional_parameter

{ columnofinterest = column_name |
  columns = column_name [, column_name [, column_name ] ] |
  equalvariance = { true | false } |
  fallback = { true | false } |
  firstcolumn = column_name |
  firstcolumnvalues = value [,...] |
  gensqlonly = { true | false } |
  groupby = column_name [,...] |
  outputdatabase = output_database_name |
  outputtablename = output_table_name |
  overwrite = { true | false } |
  paired = { true | false } |
  secondcolumn = column_name |
  secondcolumnvalues = value [,...] |
  statsdatabase = stats_database_name |
  teststyle = { t | fnway | f2way } |
  thresholdprobability = threshold_prob |
  withindicator = { true | false }
}

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

[Optional] The input table column representing the dependent variable in an F-test.

columns

[Optional] The input table column or columns representing the independent variables to analyze in an N-way F-test with equal cell counts.

If you specify multiple columns, their cell counts (the number of rows with a combination of distinct column values) must be the same.

equalvariance

[Optional] Whether to assume the variance of the two samples (columns) is equal.

Default: false

fallback

[Optional] Whether to give the output table the FALLBACK attribute.

Default: false

firstcolumn

[Optional] With teststyle=t, the input table column representing the first variable to analyze.

With teststyle=fnway or teststyle=f2way, the column representing the first independent variable in the analysis.

firstcolumnvalues

[Optional] The values of the firstcolumn column to include in the analysis.

Required with teststyle=f2way.

gensqlonly

[Optional] Disallowed with teststyle=f2way.

With teststyle=fnway or teststyle=f2way:

• 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 columns for which to separately analyze each value or combination of values.

Disallowed with teststyle=f2way.

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.

paired

[Optional] With teststyle=t, whether the first and second column values are matched with each other and the mean difference is analyzed.

Default: false

secondcolumn

[Optional] Depends on teststyle, paired, and withindicator:

teststyle	paired	Description
t	true A date type is not allowed to be used for the paired T-Test.	Input table column representing second variable to analyze.
t	false	If withindicator=true, whether second column defines two analysis categories, one where variable is negative or zero, another where it is positive.
fnway or f2way		Input table column representing second independent variable in analysis.

secondcolumnvalues

[Optional] The values of the secondcolumn column to include in the analysis.

Required with teststyle=f2way.

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] One of the following test styles:

Test Style	Description
t (default)	T-test paired, unpaired, or unpaired with indicator variable (second column).
fnway	N-way F-test with equal cell counts (1, 2, or 3 columns with same number of cell counts).
f2way	2-way F-test with unequal cell counts (2 columns with possibly different numbers of cell counts).

A cell count is the number of rows with a combination of distinct column values.

thresholdprobability

[Optional] The threshold (alpha) probability, below which the null hypothesis is rejected.

Default: 0.05

withindicator

[Optional] With teststyle=t and paired=false, whether the second column defines two analysis categories, one where the second column is negative or zero, another where it is positive.