statsmodels.othermod.betareg.BetaResults.get_distribution

BetaResults.get_distribution(exog=None, exog_precision=None, transform=True)[source]

Return a instance of the predictive distribution.

Parameters:
exogarray_like

Array of predictor variables for mean.

exog_precisionarray_like

Array of predictor variables for mean.

transformbool

If transform is True and formulas have been used, then predictor exog is passed through the formula processing. Default is True.

Returns:
Instance of a scipy frozen distribution based on estimated
parameters.

See also

predict

Notes

This function delegates to the predict method to handle exog and exog_precision, which in turn makes any required transformations.

Due to the behavior of scipy.stats.distributions objects, the returned random number generator must be called with gen.rvs(n) where n is the number of observations in the data set used to fit the model. If any other value is used for n, misleading results will be produced.