Teradata Package for Python Function Reference - 17.00 - regr_avgy - 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.regr_avgy = regr_avgy(expression)
DESCRIPTION:
    Function returns the column-wise mean of the dependent variable for all
    non-null data pairs of the dependent and independent variable arguments.
    The function considers all the valid columns in teradataml DataFrame as
    dependent variable and "expression" as a independent variable.
    Note:
        When there are fewer than two non-null data point pairs in the data used
        for the computation, the function returns None.
 
PARAMETERS:
    expression:
        Required Argument.
        Specifies a ColumnExpression of a column or name of the column or a
        literal representing an independent variable for the regression.
        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:
    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 the mean of the "gpa" column for all non-null
    #            data pairs with dependent variable as all other valid columns.
    >>> df = admissions_train.regr_avgy(admissions_train.gpa)
    >>> df
       regr_avgy_id  regr_avgy_gpa  regr_avgy_admitted
    0          20.5        3.54175                0.65
    >>>
 
    # Example 2: Calculate the mean of the "gpa" column for all non-null
    #            data pairs with dependent variable as all other valid columns,
    #            for each level of 'programming'.
    >>> df = admissions_train.groupby("programming").regr_avgy(admissions_train.gpa)
    >>> df
      programming  regr_avgy_id  regr_avgy_gpa  regr_avgy_admitted
    0    Advanced     16.812500       3.615625            0.812500
    1      Novice     20.363636       3.294545            0.727273
    2    Beginner     25.153846       3.660000            0.384615
    >>>