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

Fit

Description

The td_fit_sqle() function determines whether specified numeric transformations can be applied to specified "target_columns" and outputs a tbl_teradata to use as input "data" for td_transform_sqle() function, which does the transformations.

Usage

  td_fit_sqle (
      data = NULL,
      object = NULL,
      ...
  )

Arguments

data

Required Argument.
Specifies the input tbl_teradata.
Types: tbl_teradata

object

Required Argument.
Specifies the transformation tbl_teradata that contains transformation information for the columns in "data".
Types: tbl_teradata

...

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_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):result

Examples

  
    
    # Get the current context/connection.
    con <- td_get_context()$connection
    
    # Load the example data.
    loadExampleData("tdplyr_example", "iris_input", "transformation_table")
    
    # Create tbl_teradata object.
    iris_input <- tbl(con, "iris_input")
    transformation_df <- tbl(con, "transformation_table")
    
    # Check the list of available analytic functions.
    display_analytic_functions()
    
    # Example 1: Run td_fit_sqle() with all arguments.
    fit_df <- td_fit_sqle(data=iris_input,
                          object=transformation_df,
                          object.order.column='targetcolumn'
                         )
    
    # Print the result.
    print(fit_df)