vastorbit.VastFrame.regr

VastFrame.regr(columns: Annotated[str | list[str], 'STRING representing one column or a list of columns'] | None = None, method: Literal['avgx', 'avgy', 'count', 'intercept', 'r2', 'slope', 'sxx', 'sxy', 'syy', 'beta', 'alpha'] = 'r2', show: bool = True, chart: PlottingBase | TableSample | Axes | mFigure | Figure | None = None, **style_kwargs) → PlottingBase | TableSample | Axes | mFigure | Figure

Calculates the regression matrix for the given VastFrame.

Parameters:

• columns (SQLColumns, optional) – List of the VastColumns names. If empty, all numerical VastColumns are used.

• method (str, optional) –

  Method to use to compute the regression matrix.

  • avgx: Average of independent expression

  • avgy: Average of dependent expression

  • count: Count of all non-NULL rows

  • alpha / intercept: Intercept

  • beta / slope: Slope

  • r2: R-squared coefficient

  • sxx: Sum of squares of independent

  • sxy: Sum of products

  • syy: Sum of squares of dependent

• show (bool, optional) – If set to True, the Plotting object is returned.

• chart (PlottingObject, optional) – The chart object used to plot.

• **style_kwargs – Any optional parameter to pass to the plotting functions.

Returns:

Plotting Object.

Return type:

obj