Teradata R Package Function Reference | 17.00 - 17.00 - Antiselect - Teradata R Package

Teradata® R Package Function Reference

prodname
Teradata R Package
vrm_release
17.00
created_date
September 2020
category
Programming Reference
featnum
B700-4007-090K

Description

Antiselect returns all columns except those specified in the "exclude" argument.

Usage

  td_antiselect_mle (
    data = NULL,
    exclude = NULL,
    data.sequence.column = NULL,
    data.order.column = NULL
  )

Arguments

data

Required Argument.
Specifies the input tbl_teradata on which antiselect operation is to be performed.

data.order.column

Optional Argument.
Specifies Order By columns for "data".
Values to this argument can be provided as a vector, if multiple columns are used for ordering.
Types: character OR vector of Strings (character)

exclude

Required Argument.
Specifies the names of the columns not to return. Values to this argument can be provided as a vector, if multiple columns are used.
Note: The column names are case-sensitive.
Types: character OR vector of Strings (character)

data.sequence.column

Optional Argument.
Specifies the vector of column(s) that uniquely identifies each row of the input argument "data". The argument is used to ensure deterministic results for functions which produce results that vary from run to run.
Types: character OR vector of Strings (character)

Value

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

Examples

    # Get the current context/connection
    con <- td_get_context()$connection
    
    # Load example data.
    loadExampleData("antiselect_example", "antiselect_input")

    # Create object(s) of class "tbl_teradata".
    antiselect_input <- tbl(con, "antiselect_input")

    # Example - Exclude five columns as specified in the "exclude" argument
    td_antiselect_out <- td_antiselect_mle(data = antiselect_input,
                                       exclude = c("rowids","orderdate","discount",
                                                  "province", "custsegment")
                                       )