Teradata Package for Python Function Reference on VantageCloud Lake | 17.20 - corr - 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.corr = corr(expression)
DESCRIPTION:
    Function returns the Sample Pearson product moment correlation
    coefficient for all non-null data point pairs of ColumnExpression.
 
    The Sample Pearson product moment correlation coefficient is a measure of
    the linear association between variables. The boundary on the computed
    coefficient ranges from -1.00 to +1.00.
    Note that high correlation does not imply a causal relationship between
    the variables.
 
    The coefficient of correlation between two variables has the following four extreme values:
        1. -1.00 : Association between the variables is perfectly linear, but inverse.
                   As the value in ColumnExpression varies, the value for
                   "expression" varies identically in the opposite direction.
        2. 0     : Association between the variables does not exist and they are considered
                   to be uncorrelated.
        3. +1.00 : Association between the variables is perfectly linear.
                   As the value in ColumnExpression varies, the value for
                   "expression" varies identically in the same direction.
        4. NULL  : Association between the variables cannot be measured because there
                   are no non-null data point pairs in the data used for the computation.
 
PARAMETERS:
    expression:
        Required Argument.
        Specifies a ColumnExpression of a numeric column or name of the column or
        a numeric literal to be correlated with ColumnExpression.
        An independent variable is something that is varied under your control
        to test the behavior of another variable.
        Types: ColumnExpression OR int OR float OR str
 
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 Sample Pearson product moment correlation coefficient
    #            between 'gpa' and 'admitted' columns.
    # Execute corr() function using teradataml DataFrameColumn to generate the ColumnExpression.
    >>> corr_column = admissions_train.admitted.corr(admissions_train.gpa)
    # Pass the generated ColumnExpression to DataFrame.assign(), to run and produce the result.
    >>> df = admissions_train.assign(True, corr_=corr_column)
    >>> df
          corr_
    0 -0.022265
 
    # Example 2: Get the Sample Pearson product moment correlation coefficient
    #            between 'gpa' and 'admitted' columns for each level of programming.
    # Note:
    #   When assign() is run after DataFrame.groupby(), the function ignores
    #   the "drop_columns" argument.
    # Execute corr() function using teradataml DataFrameColumn to generate the ColumnExpression.
    >>> corr_column = admissions_train.admitted.corr(admissions_train.gpa)
    # Pass the generated ColumnExpression to DataFrame.assign(), to run and produce the result.
    >>> df=admissions_train.groupby("programming").assign(corr_=corr_column)
    >>> df
      programming     corr_
    0    Advanced  0.487737
    1      Novice -0.114656
    2    Beginner -0.417565
    >>>