PDF version (NAG web site
, 64-bit version, 64-bit version)
NAG Toolbox: nag_correg_coeffs_kspearman_miss_case_overwrite (g02bp)
Purpose
nag_correg_coeffs_kspearman_miss_case_overwrite (g02bp) computes Kendall and/or Spearman nonparametric rank correlation coefficients for a set of data omitting completely any cases with a missing observation for any variable; the data array is overwritten with the ranks of the observations.
Syntax
[
x,
rr,
ncases,
incase,
ifail] = g02bp(
x,
miss,
xmiss,
itype, 'n',
n, 'm',
m)
[
x,
rr,
ncases,
incase,
ifail] = nag_correg_coeffs_kspearman_miss_case_overwrite(
x,
miss,
xmiss,
itype, 'n',
n, 'm',
m)
Note: the interface to this routine has changed since earlier releases of the toolbox:
At Mark 22: |
n was made optional; miss and xmiss are no longer output parameters |
Description
The input data consists of
observations for each of
variables, given as an array
where
is the
th observation on the
th variable. In addition, each of the
variables may optionally have associated with it a value which is to be considered as representing a missing observation for that variable; the missing value for the
th variable is denoted by
. Missing values need not be specified for all variables.
Let
if observation
contains a missing value for any of those variables for which missing values have been declared; i.e., if
for any
for which an
has been assigned (see also
Accuracy); and
otherwise, for
.
The quantities calculated are:
(a) |
Ranks
For a given variable, say, each of the observations for which , for , has associated with it an additional number, the ‘rank’ of the observation, which indicates the magnitude of that observation relative to the magnitudes of the other observations on that same variable for which .
The smallest of these valid observations for variable is assigned the rank , the second smallest observation for variable the rank , the third smallest the rank , and so on until the largest such observation is given the rank , where .
If a number of cases all have the same value for the given variable, , then they are each given an ‘average’ rank, e.g., if in attempting to assign the rank , observations for which were found to have the same value, then instead of giving them the ranks
all observations would be assigned the rank
and the next value in ascending order would be assigned the rank
The process is repeated for each of the variables.
Let be the rank assigned to the observation when the th variable is being ranked. For those observations, , for which , , for .
The actual observations are replaced by the ranks , for and . |
(b) |
Nonparametric rank correlation coefficients
(i) |
Kendall's tau:
where |
|
and |
if |
|
if |
|
if |
and where is the number of ties of a particular value of variable , and the summation is over all tied values of variable |
(ii) |
Spearman's:
where and where is the number of ties of a particular value of variable , and the summation is over all tied values of variable . |
|
References
Siegel S (1956) Non-parametric Statistics for the Behavioral Sciences McGraw–Hill
Parameters
Compulsory Input Parameters
- 1:
– double array
-
ldx, the first dimension of the array, must satisfy the constraint
.
must be set to , the value of the th observation on the th variable, for and .
- 2:
– int64int32nag_int array
-
must be set to
if a missing value,
, is to be specified for the
th variable in the array
x, or set equal to
otherwise. Values of
miss must be given for all
variables in the array
x.
- 3:
– double array
-
must be set to the missing value,
, to be associated with the
th variable in the array
x, for those variables for which missing values are specified by means of the array
miss (see
Accuracy).
- 4:
– int64int32nag_int scalar
-
The type of correlation coefficients which are to be calculated.
- Only Kendall's tau coefficients are calculated.
- Both Kendall's tau and Spearman's coefficients are calculated.
- Only Spearman's coefficients are calculated.
Constraint:
, or .
Optional Input Parameters
- 1:
– int64int32nag_int scalar
-
Default:
the first dimension of the array
x.
, the number of observations or cases.
Constraint:
.
- 2:
– int64int32nag_int scalar
-
Default:
the dimension of the arrays
miss,
xmiss and the second dimension of the array
x. (An error is raised if these dimensions are not equal.)
, the number of variables.
Constraint:
.
Output Parameters
- 1:
– double array
-
contains the rank of the observation , for and . (For those observations containing missing values, and therefore excluded from the calculation,
, for .)
- 2:
– double array
-
The requested correlation coefficients.
If only Kendall's tau coefficients are requested (), contains Kendall's tau for the th and th variables.
If only Spearman's coefficients are requested (), contains Spearman's rank correlation coefficient for the th and th variables.
If both Kendall's tau and Spearman's coefficients are requested (
), the upper triangle of
rr contains the Spearman coefficients and the lower triangle the Kendall coefficients. That is, for the
th and
th variables, where
is less than
,
contains the Spearman rank correlation coefficient, and
contains Kendall's tau, for
and
.
(Diagonal terms,
, are unity for all three values of
itype.)
- 3:
– int64int32nag_int scalar
-
The number of cases, , actually used in the calculations (when cases involving missing values have been eliminated).
- 4:
– int64int32nag_int array
-
holds the value
if the
th case was included in the calculations, and the value
if the
th case contained a missing value for at least one variable. That is,
(see
Description), for
.
- 5:
– int64int32nag_int scalar
unless the function detects an error (see
Error Indicators and Warnings).
Error Indicators and Warnings
Errors or warnings detected by the function:
-
-
-
-
-
-
-
-
On entry, | , |
or | . |
-
-
After observations with missing values were omitted, fewer than cases remained.
-
An unexpected error has been triggered by this routine. Please
contact
NAG.
-
Your licence key may have expired or may not have been installed correctly.
-
Dynamic memory allocation failed.
Accuracy
You are warned of the need to exercise extreme care in your selection of missing values.
nag_correg_coeffs_kspearman_miss_case_overwrite (g02bp) treats all values in the inclusive range
, where
is the missing value for variable
specified in
xmiss.
You must therefore ensure that the missing value chosen for each variable is sufficiently different from all valid values for that variable so that none of the valid values fall within the range indicated above.
Further Comments
The time taken by nag_correg_coeffs_kspearman_miss_case_overwrite (g02bp) depends on and , and the occurrence of missing values.
Example
This example reads in a set of data consisting of nine observations on each of three variables. Missing values of and are declared for the first and third variables respectively; no missing value is specified for the second variable. The program then calculates and prints the rank of each observation, and both Kendall's tau and Spearman's rank correlation coefficients for all three variables, omitting completely all cases containing missing values; cases , and are therefore eliminated, leaving only six cases in the calculations.
Open in the MATLAB editor:
g02bp_example
function g02bp_example
fprintf('g02bp example results\n\n');
x = [1.7, 1, 0.5;
2.8, 4, 3.0;
0.6, 6, 2.5;
1.8, 9, 6.0;
0.99, 4, 2.5;
1.4, 2, 5.5;
1.8, 9, 7.5;
2.5, 7, 0.0;
0.99, 5, 3.0];
[n,m] = size(x);
fprintf('Number of variables (columns) = %d\n', m);
fprintf('Number of cases (rows) = %d\n\n', n);
disp('Data matrix is:-');
disp(x);
miss = [int64(1); 0; 1];
xmiss = [0.99; 0; 0];
itype = int64(0);
[x, rr, ncases, incase, ifail] = ...
g02bp( ...
x, miss, xmiss, itype);
fprintf('\nMatrix of ranks (zero rows were omitted from calculations):-\n');
disp(x);
fprintf('Matrix of rank correlation coefficients:\n');
fprintf('Upper triangle -- Spearman''s\n');
fprintf('Lower triangle -- Kendall''s tau\n\n');
disp(rr);
fprintf('Number of cases actually used = %d\n', ncases);
g02bp example results
Number of variables (columns) = 3
Number of cases (rows) = 9
Data matrix is:-
1.7000 1.0000 0.5000
2.8000 4.0000 3.0000
0.6000 6.0000 2.5000
1.8000 9.0000 6.0000
0.9900 4.0000 2.5000
1.4000 2.0000 5.5000
1.8000 9.0000 7.5000
2.5000 7.0000 0
0.9900 5.0000 3.0000
Matrix of ranks (zero rows were omitted from calculations):-
3.0000 1.0000 1.0000
6.0000 3.0000 3.0000
1.0000 4.0000 2.0000
4.5000 5.5000 5.0000
0 0 0
2.0000 2.0000 4.0000
4.5000 5.5000 6.0000
0 0 0
0 0 0
Matrix of rank correlation coefficients:
Upper triangle -- Spearman's
Lower triangle -- Kendall's tau
1.0000 0.2941 0.4058
0.1429 1.0000 0.7537
0.2760 0.5521 1.0000
Number of cases actually used = 6
PDF version (NAG web site
, 64-bit version, 64-bit version)
© The Numerical Algorithms Group Ltd, Oxford, UK. 2009–2015