Teradata Package for R Function Reference | 17.00 - 17.00 - Vantage Analytic Library Functions - Teradata Package for R

Teradata® Package for R Function Reference

Product
Teradata Package for R
Release Number
17.00
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B700-4007-090K
Language
English (United States)
 
 
Introduction to VALIB functions

Vantage Analytics Library provides the Data Scientists and other users with over 50 advanced
analytic functions built directly in the Advanced SQL Engine, which is a core capability of
Teradata Vantage. These functions support the entire data science process, including exploratory
data analysis, data preparation and feature engineering, hypothesis testing, as well as
statistical and machine learning model building and scoring.
 
The following are the pre-requisites for running VAL functions through tdplyr:
1. Install the Vantage Analytic Library in Teradata Vantage's Advanced SQL Engine. The library
   and readme file are available here for download.
2. In order to execute the VAL functions related to Statistical Tests, the Statistical Test
   Metadata tables must be loaded into a database on the system to be analyzed. This can be done
   with the help of Vantage Analytic Library installer. The Statistical Test functions provide a
   parameter called "stats_database" that can be used to specify the database in which these
   tables are installed.
 
Once the setup is done, the user is ready to use Vantage Analytic Library functions from
tdplyr. To execute Vantage Analytic Library functions,
1. Set the option 'val.install.location' to the database name where Vantage Analytics Library
   functions are installed. For example,
   options(val.install.location = "SYSLIB")
   # SYSLIB is the database name where Vantage Analytics Library functions are installed.
3. Datasets used in the tdplyr VAL functions' examples are loaded with Vantage Analytics
   Library installer.
 
Properties of VAL function output object:
1. All VAL functions return an object of class <VAL_function_name> (say valib_obj).
2. The following are the attributes of the VAL function object:
    a. The output tbl_teradata, which can be accessed as valib_obj$<output_tbl_name>.
       Details of the name(s) of the output object(s) of class tbl_teradata can be found in
       Teradata R Function Reference Guide for each individual function. The tables corresponding to
       output tbl_teradata objects are garbage collected at the end when the connection is closed.
       Users must use copy_to function to persist the output tables.
    b. show_query() function to print the underlying VAL Stored Procedure call and can be
       accessed using valib_obj %>% show_query().