Teradata Package for Python Function Reference - 17.00 - covar_samp - Teradata Package for Python

Teradata® Package for Python Function Reference

Product
Teradata Package for Python
Release Number
17.00
Release Date
November 2021
Content Type
Programming Reference
Publication ID
B700-4008-070K
Language
English (United States)
teradataml.dataframe.dataframe.DataFrame.covar_samp = covar_samp(expression)
DESCRIPTION:
    Function returns the column-wise sample covariance of its arguments
    for all non-null data point pairs. Covariance measures whether or not
    two random variables vary in the same way. It is the average of the
    products of deviations for each non-null data point pair.
    Notes:
        1. When there are no non-null data point pairs in the data used for
           the computation, the function returns None.
        2. High covariance does not imply a causal relationship between
           the variables.
 
PARAMETERS:
    expression:
        Required Argument.
        Specifies a ColumnExpression of a numeric column or name of the column
        or a numeric literal to be paired with another variable to determine
        their sample covariance.
        Types: ColumnExpression OR int OR float OR str
 
RETURNS:
    teradataml DataFrame
 
RAISES:
    RuntimeError - If none of the columns 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: Calculate sample covariance between 'admitted'
    #            and all the valid columns in teradataml DataFrame.
    >>> df = admissions_train.covar_pop(admissions_train.admitted)
    >>> df
       covar_pop_id  covar_pop_gpa  covar_pop_admitted
    0        -1.075      -0.005387              0.2275
    >>>
 
    # Example 2: Calculate sample covariance between 'admitted'
    #            and all the valid columns in teradataml DataFrame, for
    #            each level of 'programming'.
    >>> df = admissions_train.groupby("programming").covar_samp(admissions_train.admitted)
    >>> df
      programming  covar_samp_id  covar_samp_gpa  covar_samp_admitted
    0    Advanced      -0.597665        0.091056             0.152346
    1      Novice      -0.900846       -0.031488             0.198352
    2    Beginner       0.171601       -0.069232             0.236691
    >>>