OutlierFilterFit
Description
The td_outlier_filter_fit_sqle()
function calculates the lower.percentile,
upper.percentile, count of rows and median for all the "target.columns"
provided by the user. These metrics for each column helps the
function td_outlier_transform_sqle()
detect outliers in the input table. It also
stores parameters from arguments into a FIT table used during
transformation.
Notes:
This function requires the UTF8 client character set for UNICODE data.
This function does not support Pass Through Characters (PTCs).
For information about PTCs, see Teradata Vantage™ - Analytics Database International Character Set Support.
This function does not support KanjiSJIS or Graphic data types.
Usage
td_outlier_filter_fit_sqle (
data = NULL,
target.columns = NULL,
group.columns = NULL,
lower.percentile = 0.05,
upper.percentile = 0.95,
iqr.multiplier = 1.5,
outlier.method = "PERCENTILE",
replacement.value = "DELETE",
remove.tail = "BOTH",
percentile.method = "PERCENTILEDISC",
...
)
Arguments
data |
Required Argument. |
target.columns |
Required Argument. |
group.columns |
Optional Argument. |
lower.percentile |
Optional Argument. |
upper.percentile |
Optional Argument. |
iqr.multiplier |
Optional Argument. |
outlier.method |
Optional Argument.
Default Value: "PERCENTILE" |
replacement.value |
Optional Argument.
Default Value: "DELETE" |
remove.tail |
Optional Argument.
Default Value: "BOTH" |
percentile.method |
Optional Argument.
Default Value: "PERCENTILEDISC" |
... |
Specifies the generic keyword arguments SQLE functions accept. Below
are the generic keyword arguments: volatile: 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:
Note: |
Value
Function returns an object of class "td_outlier_filter_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
output.data
Examples
# Get the current context/connection.
con <- td_get_context()$connection
# Load the example data.
loadExampleData("tdplyr_example", "titanic")
# Create tbl_teradata object.
titanic_data <- tbl(con, "titanic")
# Check the list of available analytic functions.
display_analytic_functions()
# Example 1: Generating fit object to find outlier values in column "fare".
OutlierFilterFit_out <- td_outlier_filter_fit_sqle(data = titanic_data,
target.columns = "fare")
# Print the result.
print(OutlierFilterFit_out$result)
print(OutlierFilterFit_out$output.data)