Arguments - Aster Analytics

Teradata Aster Analytics Foundation User Guide

Product
Aster Analytics
Release Number
6.21
Published
November 2016
Language
English (United States)
Last Update
2018-04-14
dita:mapPath
kiu1466024880662.ditamap
dita:ditavalPath
AA-notempfilter_pdf_output.ditaval
dita:id
B700-1021
lifecycle
previous
Product Category
Software
Argument Category Description
InputTable Required Specifies the name of the table that contains the data set.
OutputPatternTable Optional Specifies the name of the table where the function outputs the patterns.
Required if PatternsOrRules is 'patterns' or 'both'; otherwise, not allowed.
OutputRuleTable Optional Specifies the name of the table where the function outputs the rules.
Required if PatternsOrRules is 'patterns' or 'both'; otherwise, not allowed.
TranItemColumns Required Specifies the names of the columns that contain transaction items to analyze.
Do not specify the same column in both this argument and the GroupByColumns argument, because this causes incorrect counting in the partitions.
TranIDColumns Required Specifies the names of the columns that contain identifiers for the transaction items.
PatternsOrRules Optional Specifies whether the function outputs patterns, rules, or both. An example of a pattern is {onions, potatoes, hamburger}. The default value is 'both'.
GroupByColumns Optional Specifies the names of columns that define the partitions into which the function groups the input data and calculates output for it. At least one column must be usable as a distribution key.

If you omit this argument, then the function considers all input data to be in a single partition.

Do not specify the same column in both this argument and the TranItemColumns argument, because this causes incorrect counting in the partitions.
PatternDistributionKeyColumn Optional Specifies the name of the column to use as the distribution key for output_pattern_table. The default value is 'pattern_tranitemcolumns'.
RuleDistributionKeyColumn Optional Specifies the name of the column to use as the distribution key for output_rule_table. The default value is 'antecedent_tranitemcolumns'.
Compress Optional Specifies the compression level the output tables. The default value is 'nocompress'.

Realized compression ratios depend on both this value and the data characteristics. These ratios typically range from 3x to 12x. For more information about compression, see Teradata Aster® Database User Guide for Aster Appliances.

DropTable Optional Specifies whether the function drops and then creates output_pattern_table or output_rule_table if it exists ('true') or issues an error message ('false'). The default value is 'false'.
GroupSize Optional Specifies the number of transaction items to be assigned to each worker. This value must be an INTEGER in the range from 1 to the number of distinct transaction items, inclusive. For a machine with limited RAM, use a relatively small value. The default value is 4.
MinSupport Optional Specifies the minimum support value of returned patterns (including the specified support value). This value must be a DECIMAL in the range [0, 1]. The default value is 0.05.
MinConfidence Optional Specifies the minimum confidence value of returned patterns (including the specified confidence value). This value must be a DECIMAL in the range [0, 1]. The default value is 0.8.
MaxPatternLength Optional Specifies the maximum length of returned patterns. The length of a pattern is the sum of the item numbers in the antecedent and consequence columns. This value must be an INTEGER greater than 2. The default value is 10.

MaxPatternLength also limits the length of returned rules to this value.

AntecedentCountRange Optional Specifies the range for na, the number of items in the antecedent. The function returns only patterns for which na is in the range [lower_bound, upper_bound]. The lower_bound must be greater an integer greater than 0. The lower_bound and upper_bound can be equal. The default value is '1-infinite'.
ConsequenceCountRange Optional Specifies the range for nc, the number of items in the consequence. The function returns only patterns for which nc is in the range [lower_bound, upper_bound]. The lower_bound must be greater an integer greater than 0. The lower_bound and upper_bound can be equal. The default value is '1-1'.
Delimiter Optional Specifies the delimiter that separates items in the output. The default value is ',' (that is, the default delimiter is comma).