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

NonLinearCombineFit

Description

The td_non_linear_combine_fit_sqle() function returns the target columns and a specified formula which uses the non-linear combination of existing features.

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™ - Analytics Database International Character Set Support.

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

Usage

  td_non_linear_combine_fit_sqle (
      data = NULL,
      target.columns = NULL,
      formula = NULL,
      result.column = NULL,
      ...
  )

Arguments

data

Required Argument.
Specifies the input tbl_teradata.
Types: tbl_teradata

target.columns

Required Argument.
Specifies the name(s) of the column(s) in "data" to run the non-linear combination.
Types: character OR vector of Strings (character)

formula

Required Argument.
Specifies the formula to be used for non-linear combination.
Types: character

result.column

Required Argument.
Specifies the name of the new feature column generated by the td_transform_sqle function.
This function saves the specified formula in this column.
Types: character

...

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 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_non_linear_combine_fit_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. result

  2. output.data

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 : Create model to obtain total cost for passenger 
    #             using formula ('sibsp' + 'parch' + 1) * 'fare'.
    NonLinearCombineFit_out <- td_non_linear_combine_fit_sqle(
                                                  data = titanic,
                                                  target.columns = c("sibsp", "parch", "fare"),
                                                  formula = "Y=(X0+X1+1)*X2",
                                                  result.column = "total_cost")
    
    # Print the result tbl_teradata objects.
    print(NonLinearCombineFit_out$result)
    print(NonLinearCombineFit_out$output.data)