Teradata R Package Function Reference | 17.00 - 17.00 - Pack - 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

The Pack function packs data from multiple input columns into a single column. The packed column has a virtual column for each input column. By default, virtual columns are separated by commas and each virtual column value is labeled with its column name.

Usage

  td_pack_mle (
    data = NULL,
    input.columns = NULL,
    output.column = NULL,
    delimiter = ",",
    include.column.name = TRUE,
    data.sequence.column = NULL,
    data.order.column = NULL
  )

Arguments

data

Required Argument.
Specifies the tbl_teradata containing the input attributes.

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)

input.columns

Optional Argument.
Specifies the names of the input columns to pack into a single output column. These names become the column names of the virtual columns. By default, all input tbl_teradata columns are packed into a single output column. If you specify this argument, but do not specify all input tbl_teradata columns, the function copies the unspecified input tbl_teradata columns to the output tbl_teradata.
Types: character OR vector of Strings (character)

output.column

Required Argument.
Specifies the name to give to the packed output column.
Types: character

delimiter

Optional Argument.
Specifies the delimiter (a string) that separates the virtual columns in the packed data.
Default Value: ","
Types: character

include.column.name

Optional Argument.
Specifies whether to label each virtual column value with its column name (making the virtual column "input_column:value").
Default Value: TRUE
Types: logical

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_pack_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("pack_example", "ville_temperature")

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

    # Example 1 -
    td_pack_out1 <- td_pack_mle(data = ville_temperature,
                                input.columns = c("city", "state", "period", "temp_f"),
                                output.column = "packed_data",
                                delimiter = ",",
                                include.column.name = TRUE
                                )

    # Example 2 -
    td_pack_out2 <- td_pack_mle(data = ville_temperature,
                                input.columns = c("city", "state", "period", "temp_f"),
                                output.column = "packed_data",
                                delimiter = "|",
                                include.column.name = FALSE
                                )