Teradata R Package Function Reference - 16.20 - ScaleSummary - Teradata R Package

Teradata® R Package Function Reference

prodname
Teradata R Package
vrm_release
16.20
created_date
February 2020
category
Programming Reference
featnum
B700-4007-098K

Description

The ScaleSummary function (td_scale_summary_mle) takes the ScaleMap output (statistics assembled at the vworker level) as input and outputs global statistical information for the entire input data set.

Usage

  td_scale_summary_mle (
    object = NULL
  )

Arguments

object

Required Argument.
Specifies the output of td_scale_map_mle function.

Value

Function returns an object of class "td_scale_summary_mle" which is a named list containing Teradata tbl object.
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("scale_example", "scale_stat")
    
    # Create remote tibble objects.
    scale_stat_input <- tbl(con, "scale_stat")
    
    # Example 1 - This functions takes the input as ScaleMap output (scale_stat)
    # and outputs global statistical information for the entire input data set.
    td_scale_summary_out <- td_scale_summary_mle(object = scale_stat_input)