Teradata Package for R Function Reference | 17.20 - ChiSq - Teradata Package for R - Look here for syntax, methods and examples for the functions included in the Teradata Package for R.

Teradata® Package for R Function Reference

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Teradata Package for R
Release Number
17.20
Published
March 2024
Language
English (United States)
Last Update
2024-05-03
dita:id
TeradataR_FxRef_Enterprise_1720
Product Category
Teradata Vantage

ChiSq

Description

The td_chi_sq_sqle() function performs Pearson's chi-squared (χ2) test for independence, which determines if there is a statistically significant difference between the expected and observed frequencies in one or more categories of a contingency table (also called a cross tabulation).

Usage

  td_chi_sq_sqle (
      data = NULL,
      alpha = 0.05,
      ...
  )

Arguments

data

Required Argument.
Specifies the input tbl_teradata.
Types: tbl_teradata

alpha

Optional Argument.
Specifies the probability below which the null hypothesis is rejected.
"alpha" must be a numeric value in the range [0, 1].
Default Value: 0.05
Types: float

...

Specifies the generic keyword arguments SQLE functions accept.
Below are the generic keyword arguments:

persist:
Optional Argument.
Specifies whether to persist the results of the function in a table or
not. When set to TRUE, results are persisted in a table; otherwise, results are garbage collected at the end of the session.
Default Value: FALSE
Types: logical

volatile:
Optional Argument.
Specifies whether to put the results of the function in a volatile table
or not. When set to TRUE, results are stored in a volatile table, otherwise not.
Default Value: FALSE
Types: logical

Function allows the user to partition, hash, order or local order the input data. These generic arguments are available for each argument that accepts tbl_teradata as input and can be accessed as:

  • "<input.data.arg.name>.partition.column" accepts character OR vector of Strings (character) (Strings)

  • "<input.data.arg.name>.hash.column" accepts character OR vector of Strings (character) (Strings)

  • "<input.data.arg.name>.order.column" accepts character OR vector of Strings (character) (Strings)

  • "local.order.<input.data.arg.name>" accepts logical

Note:
These generic arguments are supported by tdplyr if the underlying SQL Engine function supports, else an exception is raised.

Value

Function returns an object of class "td_chi_sq_sqle" which is a named list containing object of class "tbl_teradata".
Named list member(s) can be referenced directly with the "$" operator using the name(s):

  1. output.data

  2. result

Examples

  
    
    # Get the current context/connection.
    con <- td_get_context()$connection
    
    # Load the example data.
    loadExampleData("tdplyr_example", "chi_sq")
    
    # Create tbl_teradata object.
    chi_sq_data <- tbl(con, "chi_sq")
    
    # Check the list of available analytic functions.
    display_analytic_functions()
    
    # Example: Run td_chi_sq_sqle() with all arguments.
    obj <- td_chi_sq_sqle(data=chi_sq_data,
                          alpha=0.5)
    
    # Print the output and expected values tbl_teradata.
    print(obj$result)
    print(obj$output.data)