statsmodels.formula.api.phreg

statsmodels.formula.api.phreg(formula, data, status=None, entry=None, strata=None, offset=None, subset=None, ties='breslow', missing='drop', *args, **kwargs)

Create a proportional hazards regression model from a formula and dataframe.

Parameters:
formulastr or generic Formula object

The formula specifying the model

dataarray_like

The data for the model. See Notes.

statusarray_like

The censoring status values; status=1 indicates that an event occurred (e.g. failure or death), status=0 indicates that the observation was right censored. If None, defaults to status=1 for all cases.

entryarray_like

The entry times, if left truncation occurs

strataarray_like

Stratum labels. If None, all observations are taken to be in a single stratum.

offsetarray_like

Array of offset values

subsetarray_like

An array-like object of booleans, integers, or index values that indicate the subset of df to use in the model. Assumes df is a pandas.DataFrame

tiesstr

The method used to handle tied times, must be either ‘breslow’ or ‘efron’.

missingstr

The method used to handle missing data

argsextra arguments

These are passed to the model

kwargsextra keyword arguments

These are passed to the model with one exception. The eval_env keyword is passed to patsy. It can be either a patsy:patsy.EvalEnvironment object or an integer indicating the depth of the namespace to use. For example, the default eval_env=0 uses the calling namespace. If you wish to use a “clean” environment set eval_env=-1.

Returns:
modelPHReg model instance

Last update: Apr 12, 2024