naginterfaces.library.surviv.coxmodel_​risksets

naginterfaces.library.surviv.coxmodel_risksets(ns, z, isz, ip, t, ic, isi, mxn)

coxmodel_risksets creates the risk sets associated with the Cox proportional hazards model for fixed covariates.

For full information please refer to the NAG Library document for g12za

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/g12/g12zaf.html

Parameters

nsint

The number of strata. If $ns>0$ then the stratum for each observation must be supplied in $isi$.

zfloat, array-like, shape $(n,m)$

The $i$th row must contain the covariates which are associated with the $i$th failure time given in $t$.

iszint, array-like, shape $\left(m\right)$

Indicates which subset of covariates are to be included in the model.

$isz[j-1]\ge 1$

The $j$th covariate is included in the model.

$isz[j-1]=0$

The $j$th covariate is excluded from the model and not referenced.

ipint

$p$, the number of covariates included in the model as indicated by $isz$.

tfloat, array-like, shape $\left(n\right)$

The vector of $n$ failure censoring times.

icint, array-like, shape $\left(n\right)$

The status of the individual at time $t$ given in $t$.

$ic[i-1]=0$

Indicates that the $i$th individual has failed at time $t[i-1]$.

$ic[i-1]=1$

Indicates that the $i$th individual has been censored at time $t[i-1]$.

isiint, array-like, shape $(:)$

Note: the required length for this argument is determined as follows: if $ns>0$: $n$; otherwise: $1$.

If $ns>0$, the stratum indicators which also allow data points to be excluded from the analysis.

If $ns=0$, $isi$ is not referenced.

$isi\left[i\right]=k$

Indicates that the $i$th data point is in the $k$th stratum, where $k=1,2,\dots ,ns$.

$isi\left[i\right]=0$

Indicates that the $i$th data point is omitted from the analysis.

mxnint

The first dimension of the array $x$.

The dimension of the arrays $ixs$ and $fid$.

Returns

numint

The number of values in the combined risk sets.

ixsint, ndarray, shape $\left(mxn\right)$

The factor giving the risk sets/strata for the data in $x$ and $fid$.

If $ns=0$ or $1$, $ixs[i-1]=l$ for members of the $l$th risk set.

If $ns>1$, $ixs[i-1]=(j-1)\times nd+l$ for the observations in the $l$th risk set for the $j$th strata.

nxsint

The number of levels for the risk sets/strata factor given in $ixs$.

xfloat, ndarray, shape $(num,ip)$

The first $num$ rows contain the values of the covariates for the members of the risk sets.

fidint, ndarray, shape $\left(mxn\right)$

Indicates if the member of the risk set given in $x$ failed.

$fid[i-1]=1$ if the member of the risk set failed at the time defining the risk set and $fid[i-1]=0$ otherwise.

ndint

The number of distinct failure times, i.e., the number of risk sets.

tpfloat, ndarray, shape $\left(n\right)$

$tp[\text{i}-1]$ contains the $\text{i}$th distinct failure time, for $\text{i}=1,2,\dots ,nd$.

irsint, ndarray, shape $\left(n\right)$

Indicates rows in $x$ and elements in $ixs$ and $fid$ corresponding to the risk sets. The first risk set corresponding to failure time $tp\left[0\right]$ is given by rows $1$ to $irs\left[0\right]$. The $\text{l}$th risk set is given by rows $irs[\text{l}-2]+1$ to $irs[\text{l}-1]$, for $\text{l}=1,2,\dots ,nd$.

Raises

NagValueError

(errno $1$)

On entry, $ns=⟨value⟩$.

Constraint: $ns\ge 0$.

(errno $1$)

On entry, $n=⟨value⟩$.

Constraint: $n\ge 2$.

(errno $1$)

On entry, $m=⟨value⟩$.

Constraint: $m\ge 1$.

(errno $2$)

On entry, $i=⟨value⟩$, $isi[i-1]=⟨value⟩$ and $ns=⟨value⟩$.

Constraint: $0\le isi[i-1]\le ns$.

(errno $2$)

On entry, $i=⟨value⟩$ and $ic[i-1]=⟨value⟩$.

Constraint: $ic[i-1]=0$ or $1$.

(errno $2$)

On entry, there are not $ip$ values of $isz>0$.

(errno $2$)

On entry, $i=⟨value⟩$ and $isz[i-1]=⟨value⟩$.

Constraint: $isz[j-1]\ge 0$.

(errno $3$)

On entry, $mxn=⟨value⟩$ and minimum value for $mxn=⟨value⟩$.

Constraint: $mxn$ must be sufficiently large for the arrays to contain the expanded risk set.

Notes

The Cox proportional hazards model (see Cox (1972)) relates the time to an event, usually death or failure, to a number of explanatory variables known as covariates. Some of the observations may be right-censored, that is, the exact time to failure is not known, only that it is greater than a known time.

Let $t_{\text{i}}$, for $\text{i}=1,2,\dots ,n$, be the failure time or censored time for the $i$th observation with the vector of $p$ covariates $z_i$. It is assumed that censoring and failure mechanisms are independent. The hazard function, $\lambda (t,z)$, is the probability that an individual with covariates $z$ fails at time $t$ given that the individual survived up to time $t$. In the Cox proportional hazards model, $\lambda (t,z)$ is of the form

$$\lambda (t,z)={\lambda }_0\left(t\right)exp\left(z^T\beta \right)\text{,}$$

where ${\lambda }_0$ is the base-line hazard function, an unspecified function of time, and $\beta$ is a vector of unknown parameters. As ${\lambda }_0$ is unknown, the parameters $\beta$ are estimated using the conditional or marginal likelihood. This involves considering the covariate values of all subjects that are at risk at the time when a failure occurs. The probability that the subject that failed had their observed set of covariate values is computed.

The risk set at a failure time consists of those subjects that fail or are censored at that time and those who survive beyond that time. As risk sets are computed for every distinct failure time, it should be noted that the combined risk sets may be considerably larger than the original data. If the data can be considered as coming from different strata such that ${\lambda }_0$ varies from strata to strata but $\beta$ remains constant, then coxmodel_risksets will return a factor that indicates to which risk set/strata each member of the risk sets belongs rather than just to which risk set.

Given the risk sets the Cox proportional hazards model can then be fitted using a Poisson generalized linear model (correg.glm_poisson with anova.dummyvars to compute dummy variables) using Breslow’s approximation for ties (see Breslow (1974)). This will give the same fit as coxmodel(). If the exact treatment of ties in discrete time is required, as given by Cox (1972), then the model is fitted as a conditional logistic model using contab.condl_logistic.

References

Breslow, N E, 1974, Covariate analysis of censored survival data, Biometrics (30), 89–99

Cox, D R, 1972, Regression models in life tables (with discussion), J. Roy. Statist. Soc. Ser. B (34), 187–220

Gross, A J and Clark, V A, 1975, Survival Distributions: Reliability Applications in the Biomedical Sciences, Wiley