NAG Library Routine Document

Integer, Intent (In)	::	n, ic(n), grp(n), ngrp, ifreq(*), ldn
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	df, nd, di(ldn), ni(ldn)
Real (Kind=nag_wp), Intent (In)	::	t(n), wt(*)
Real (Kind=nag_wp), Intent (Out)	::	ts, p, obsd(ngrp), expt(ngrp)
Character (1), Intent (In)	::	freq, weight

C Header Interface

#include <nagmk26.h>

void

g12abf_ (const Integer *n, const double t[], const Integer ic[], const Integer grp[], const Integer *ngrp, const char *freq, const Integer ifreq[], const char *weight, const double wt[], double *ts, Integer *df, double *p, double obsd[], double expt[], Integer *nd, Integer di[], Integer ni[], const Integer *ldn, Integer *ifail, const Charlen length_freq, const Charlen length_weight)

3

Description

A survivor function,

S (t)

, is the probability of surviving to at least time

t

. Given a series of

n

failure or right-censored times from

g

groups g12abf calculates a rank statistic for testing the null hypothesis

$H_{0} : S_{1} (t) = S_{2} (t) = \dots = S_{g} (t), \forall t \leq τ$

where

τ

is the largest observed time, against the alternative hypothesis

$H_{1} :$ at least one of the $S_{i} (t)$ differ, for some $t \leq τ$ .

Let

t_{i}

, for

i = 1, 2, \dots, n_{d}

, denote the list of distinct failure times across all

g

groups and

w_{i}

a series of

n_{d}

weights. Let

d_{i j}

denote the number of failures at time

t_{i}

in group

j

and

n_{i j}

denote the number of observations in the group

j

that are known to have not failed prior to time

t_{i}

, i.e., the size of the risk set for group

j

at time

t_{i}

. If a censored observation occurs at time

t_{i}

then that observation is treated as if the censoring had occurred slightly after

t_{i}

and therefore the observation is counted as being part of the risk set at time

t_{i}

. Finally let

d_{i} = \sum_{j = 1}^{g} d_{i j} and n_{i} = \sum_{j = 1}^{g} n_{i j} .

The (weighted) number of observed failures in the

j

th group,

O_{j}

, is therefore given by

O_{j} = \sum_{i = 1}^{n_{d}} w_{i} d_{i j}

and the (weighted) number of expected failures in the

j

th group,

E_{j}

, by

E_{j} = \sum_{i = 1}^{n_{d}} w_{i} \frac{n_{i j} d_{i}}{n_{i}} .

x

denotes the vector of differences

x = (O_{1} - E_{1}, O_{2} - E_{2}, \dots, O_{g} - E_{g})

and

V_{j k} = \sum_{i = 1}^{n_{d}} w_{i}^{2} (\frac{d_{i} (n_{i} - d_{i}) (n_{i} n_{i k} I_{j k} - n_{i j} n_{i k})}{n_{i}^{2} (n_{i} - 1)})

where

I_{j k} = 1

j = k

and

0

otherwise, then the rank statistic,

T

, is calculated as

T = x V^{-} x^{T}

where

V^{-}

denotes a generalized inverse of the matrix

V

. Under the null hypothesis,

T \sim χ_{ν}^{2}

where the degrees of freedom,

ν

, is taken as the rank of the matrix

V

4

References

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

Kalbfleisch J D and Prentice R L (1980) The Statistical Analysis of Failure Time Data Wiley

Rostomily R C, Duong D, McCormick K, Bland M and Berger M S (1994) Multimodality management of recurrent adult malignant gliomas: results of a phase II multiagent chemotherapy study and analysis of cytoreductive surgery Neurosurgery 35 378

5

Arguments

1: $n$ – IntegerInput

On entry:

n

, the number of failure and censored times.

Constraint:

n \geq 2

2: $t (n)$ – Real (Kind=nag_wp) arrayInput

On entry: the observed failure and censored times; these need not be ordered.

Constraint:

t (i) \neq t (j)

for at least one

i \neq j

, for

i = 1, 2, \dots, n

and

j = 1, 2, \dots, n

3: $ic (n)$ – Integer arrayInput

On entry:

ic (i)

contains the censoring code of the

i

th observation, for

i = 1, 2, \dots, n

$ic (i) = 0$: the $i$ th observation is a failure time.
$ic (i) = 1$: the $i$ th observation is right-censored.

Constraints:

$ic (i) = 0$ or $1$ , for $i = 1, 2, \dots, n$ ;
$ic (i) = 0$ for at least one $i$ .

4: $grp (n)$ – Integer arrayInput

On entry:

grp (i)

contains a flag indicating which group the

i

th observation belongs in, for

i = 1, 2, \dots, n

Constraints:

$1 \leq grp (i) \leq ngrp$ , for $i = 1, 2, \dots, n$ ;
each group must have at least one observation.

5: $ngrp$ – IntegerInput

On entry:

g

, the number of groups.

Constraint:

2 \leq ngrp \leq n

6: $freq$ – Character(1)Input

On entry: indicates whether frequencies are provided for each time point.

$freq ='F'$: Frequencies are provided for each failure and censored time.
$freq ='S'$: The failure and censored times are considered as single observations, i.e., a frequency of $1$ is assumed.

Constraint:

freq ='F'

'S'

7: $ifreq (*)$ – Integer arrayInput

Note: the dimension of the array ifreq must be at least

n

freq ='F'

On entry: if

freq ='F'

ifreq (i)

must contain the frequency (number of observations) to which each entry in t corresponds.

freq ='S'

, each entry in t is assumed to correspond to a single observation, i.e., a frequency of

1

is assumed, and ifreq is not referenced.

Constraint: if

freq ='F'

ifreq (i) \geq 0

, for

i = 1, 2, \dots, n

8: $weight$ – Character(1)Input

On entry: indicates if weights are to be used.

$weight ='U'$: All weights are assumed to be $1$ .
$weight ='W'$: The weights, $w_{i}$ are supplied in wt.

Constraint:

weight ='U'

'W'

9: $wt (*)$ – Real (Kind=nag_wp) arrayInput

Note: the dimension of the array wt must be at least

ldn

weight ='W'

On entry: if

weight ='W'

, wt must contain the

n_{d}

weights,

w_{i}

, where

n_{d}

is the number of distinct failure times.

weight ='U'

, wt is not referenced and

w_{i} = 1

for all

i

Constraint: if

weight ='W'

wt (i) \geq 0.0

, for

i = 1, 2, \dots, n_{d}

10: $ts$ – Real (Kind=nag_wp)Output

On exit:

T

, the test statistic.

11: $df$ – IntegerOutput

On exit:

ν

, the degrees of freedom.

12: $p$ – Real (Kind=nag_wp)Output

On exit:

P (X \geq T)

, when

X \sim χ_{ν}^{2}

, i.e., the probability associated with ts.

13: $obsd (ngrp)$ – Real (Kind=nag_wp) arrayOutput

On exit:

O_{i}

, the observed number of failures in each group.

14: $expt (ngrp)$ – Real (Kind=nag_wp) arrayOutput

On exit:

E_{i}

, the expected number of failures in each group.

15: $nd$ – IntegerOutput

On exit:

n_{d}

, the number of distinct failure times.

16: $di (ldn)$ – Integer arrayOutput

On exit: the first nd elements of di contain

d_{i}

, the number of failures, across all groups, at time

t_{i}

17: $ni (ldn)$ – Integer arrayOutput

On exit: the first nd elements of ni contain

n_{i}

, the size of the risk set, across all groups, at time

t_{i}

18: $ldn$ – IntegerInput

On entry: the size of arrays di and ni. As

n_{d} \leq n

, if

n_{d}

is not known a priori then a value of n can safely be used for ldn.

Constraint:

ldn \geq n_{d}

, the number of unique failure times.

19: $ifail$ – IntegerInput/Output

On entry: ifail must be set to

0

- 1 or 1

. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value

- 1 or 1

is recommended. If the output of error messages is undesirable, then the value

1

is recommended. Otherwise, if you are not familiar with this argument, the recommended value is

0

. When the value $- 1 or 1$ is used it is essential to test the value of ifail on exit.

On exit:

ifail = 0

unless the routine detects an error or a warning has been flagged (see Section 6).

6

Error Indicators and Warnings

If on entry

ifail = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: On entry, $n = 〈value〉$ .
Constraint: $n \geq 2$ .

$ifail = 2$: On entry, all the times in t are the same.

$ifail = 3$: On entry, $ic (〈value〉) = 〈value〉$ .
Constraint: $ic (i) = 0$ or $1$ .

$ifail = 4$: On entry, $grp (〈value〉) = 〈value〉$ and $ngrp = 〈value〉$ .
Constraint: $1 \leq grp (i) \leq ngrp$ .

$ifail = 5$: On entry, $ngrp = 〈value〉$ and $n = 〈value〉$ .
Constraint: $2 \leq ngrp \leq n$ .

$ifail = 6$: On entry, freq had an illegal value.

$ifail = 7$: On entry, $ifreq (〈value〉) = 〈value〉$ .
Constraint: $ifreq (i) \geq 0$ .

$ifail = 8$: On entry, weight had an illegal value.

$ifail = 9$: On entry, $wt (〈value〉) = 〈value〉$ .
Constraint: $wt (i) \geq 0.0$ .

$ifail = 11$: The degrees of freedom are zero.

$ifail = 18$: On entry, $ldn = 〈value〉$ .
Constraint: $ldn \geq 〈value〉$ .

$ifail = 31$: On entry, all observations are censored.

$ifail = 41$: On entry, group $〈value〉$ has no observations.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

Not applicable.

8

Parallelism and Performance

g12abf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

g12abf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9

Further Comments

The use of different weights in the formula given in Section 3 leads to different rank statistics being calculated. The logrank test has

w_{i} = 1

, for all

i

, which is the equivalent of calling g12abf when

weight ='U'

. Other rank statistics include Wilcoxon (

w_{i} = n_{i}

), Tarone–Ware (

w_{i} = \sqrt{n_{i}}

) and Peto–Peto (

w_{i} = \tilde{S} (t_{i})

where

\tilde{S} (t_{i}) = \prod_{t_{j} \leq t_{i}} \frac{n_{j} - d_{j} + 1}{n_{j} + 1}

) amongst others.

Calculation of any test, other than the logrank test, will probably require g12abf to be called twice, once to calculate the values of

n_{i}

and

d_{i}

to facilitate in the computation of the required weights, and once to calculate the test statistic itself.

10

Example

This example compares the time to death for

51

adults with two different types of recurrent gliomas (brain tumour), astrocytoma and glioblastoma, using a logrank test. For further details on the data see Rostomily et al. (1994).

NAG Library Routine Document

g12abf (logrank)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

6

Error Indicators and Warnings

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

10.2

Program Data

10.3

Program Results