Teradata Package for Python Function Reference on VantageCloud Lake | 17.20 - kurtosis - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the Teradata Package for Python.

Teradata® Package for Python Function Reference on VantageCloud Lake

Deployment
VantageCloud
Edition
Lake
Product
Teradata Package for Python
Release Number
17.20
Publication Date
November 2022
Content Type
Programming Reference
Publication ID
B700-4500-112K
ft:locale
en-US
ft:lastEdition
2024-02-21
ft:sourceId
FTML
dita:id
TeradataPython_FxRef_Lake_1720
Product Category
Teradata Vantage
teradataml.dataframe.sql.DataFrameColumn.kurtosis = kurtosis(self, distinct=False, **kwargs)
DESCRIPTION:
    Function returns kurtosis value for a column.
    Kurtosis is the fourth moment of the distribution of the standardized
    (z) values. It is a measure of the outlier (rare, extreme observation)
    character of the distribution as compared with the normal, Gaussian
    distribution.
        * The normal distribution has a kurtosis of 0.
        * Positive kurtosis indicates that the distribution is more
          outlier-prone than the normal distribution.
        * Negative kurtosis indicates that the distribution is less
          outlier-prone than the normal distribution.
 
PARAMETERS:
    distinct:
        Optional Argument.
        Specifies a flag that decides whether to consider duplicate values in
        a column or not.
        Default Values: False
        Types: bool
 
    kwargs:
        Specifies optional keyword arguments.
 
RETURNS:
     ColumnExpression, also known as, teradataml DataFrameColumn.
 
NOTES:
     * One must use DataFrame.assign() when using the aggregate functions on
       ColumnExpression, also known as, teradataml DataFrameColumn.
     * One should always use "drop_columns=True" in DataFrame.assign(), while
       running the aggregate operation on teradataml DataFrame.
     * "drop_columns" argument in DataFrame.assign() is ignored, when aggregate
       function is operated on DataFrame.groupby().
 
RAISES:
    RuntimeError - If column does not support the aggregate operation.
 
EXAMPLES:
    # Load the data to run the example.
    >>> load_example_data("dataframe", "admissions_train")
    >>>
    # Create a DataFrame on 'admissions_train' table.
    >>> admissions_train = DataFrame("admissions_train")
    >>> admissions_train
       masters   gpa     stats programming  admitted
    id
    22     yes  3.46    Novice    Beginner         0
    36      no  3.00  Advanced      Novice         0
    15     yes  4.00  Advanced    Advanced         1
    38     yes  2.65  Advanced    Beginner         1
    5       no  3.44    Novice      Novice         0
    17      no  3.83  Advanced    Advanced         1
    34     yes  3.85  Advanced    Beginner         0
    13      no  4.00  Advanced      Novice         1
    26     yes  3.57  Advanced    Advanced         1
    19     yes  1.98  Advanced    Advanced         0
    >>>
 
    # Example 1: Get the kurtosis of the values in 'gpa' column.
    # Execute kurtosis() function using teradataml DataFrameColumn to generate the ColumnExpression.
    >>> kurtosis_column = admissions_train.gpa.kurtosis()
    # Pass the generated ColumnExpression to DataFrame.assign(), to run and produce the result.
    >>> df = admissions_train.assign(True, kurtosis_=kurtosis_column)
    >>> df
       kurtosis_
    0   4.052659
    >>>
 
    # Example 2: Get the kurtosis of the distinct values in 'gpa' column
    #            for each level of programming.
    # Note:
    #   When assign() is run after DataFrame.groupby(), the function ignores
    #   the "drop_columns" argument.
    # Execute kurtosis() function using teradataml DataFrameColumn to generate the ColumnExpression.
    >>> kurtosis_column = admissions_train.gpa.kurtosis(distinct=True)
    # Pass the generated ColumnExpression to DataFrame.assign(), to run and produce the result.
    >>> df=admissions_train.groupby("programming").assign(kurtosis_=kurtosis_column)
    >>> df
      programming  kurtosis_
    0    Advanced   8.106762
    1      Novice   1.420745
    2    Beginner   5.733691
    >>>