Teradata Package for R Function Reference | 17.20 - GetFutileColumns - 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

GetFutileColumns

Description

td_get_futile_columns_sqle() function returns the futile column names if either of the conditions is met:

  • If all the values in the columns are unique

  • If all the values in the columns are the same

  • If the count of distinct values in the columns divided by the count of the total number of rows in the input data is greater than or equal to the threshold value

Notes:

  • This function requires the UTF8 client character set for UNICODE data.

  • This function does not support Pass Through Characters (PTCs). For information about PTCs, see Teradata Vantage™ - Advanced SQL Engine International Character Set Support.

  • This function does not support KanjiSJIS or Graphic data types.

  • This function works only for categorical data.

Usage

  td_get_futile_columns_sqle (
      data = NULL,
      object = NULL,
      category.summary.column = NULL,
      threshold.value = NULL,
      ...
  )

Arguments

data

Required Argument.
Specifies the input tbl_teradata.
Types: tbl_teradata

object

Required Argument.
Specifies the tbl_teradata containing the categorical summary generated by td_categorical_summary_sqle() or the instance of td_categorical_summary_sqle.
Types: tbl_teradata or td_categorical_summary_sqle

category.summary.column

Required Argument.
Specifies the column from categorical summary tbl_teradata which provides names of the columns in "data".
Types: character

threshold.value

Required Argument.
Specifies the threshold value for the columns in "data".
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.
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.
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 character (Strings)

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

  • "<input.data.arg.name>.order.column" accepts character or vector of 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_get_futile_columns_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):result

Examples

  
    
    # Get the current context/connection.
    con <- td_get_context()$connection
    
    # Load the example data.
    loadExampleData("tdplyr_example", "titanic")
    
    # Create tbl_teradata object.
    titanic <- tbl(con, "titanic")
    
    # Check the list of available analytic functions.
    display_analytic_functions()
    
    # Example 1 : Get futiles columns from target columns 'cabin', 'sex', and 'ticket'.
    categoricalsummary_out <- td_categorical_summary_sqle(data=titanic,
                                                          target.columns=
                                                            c("cabin", "sex",
                                                            "ticket"))
    getfutilecolumns_out <- td_get_futile_columns_sqle(
                              data=titanic,
                              object=categoricalsummary_out$result,
                              category.summary.column="ColumnName",
                              threshold.value=0.7)
    
    # Print the result.
    print(getfutilecolumns_out$result)