# NAG FL Interfaceg02bnf (coeffs_​kspearman_​overwrite)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

g02bnf computes Kendall and/or Spearman nonparametric rank correlation coefficients for a set of data; the data array is overwritten with the ranks of the observations.

## 2Specification

Fortran Interface
 Subroutine g02bnf ( n, m, x, ldx, rr, ldrr,
 Integer, Intent (In) :: n, m, ldx, itype, ldrr Integer, Intent (Inout) :: ifail Integer, Intent (Out) :: kworka(n), kworkb(n) Real (Kind=nag_wp), Intent (Inout) :: x(ldx,m), rr(ldrr,m) Real (Kind=nag_wp), Intent (Out) :: work1(m), work2(m)
#include <nag.h>
 void g02bnf_ (const Integer *n, const Integer *m, double x[], const Integer *ldx, const Integer *itype, double rr[], const Integer *ldrr, Integer kworka[], Integer kworkb[], double work1[], double work2[], Integer *ifail)
The routine may be called by the names g02bnf or nagf_correg_coeffs_kspearman_overwrite.

## 3Description

The input data consists of $n$ observations for each of $m$ variables, given as an array
 $[xij], i=1,2,…,n (n≥2),j=1,2,…,m(m≥2),$
where ${x}_{ij}$ is the $i$th observation of the $j$th variable.
The quantities calculated are:
1. (a)Ranks
For a given variable, $j$ say, each of the $n$ observations, ${x}_{1j},{x}_{2j},\dots ,{x}_{nj}$, 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 $n-1$ observations on that same variable.
The smallest observation for variable $j$ is assigned the rank $1$, the second smallest observation for variable $j$ the rank $2$, the third smallest the rank $3$, and so on until the largest observation for variable $j$ is given the rank $n$.
If a number of cases all have the same value for the given variable, $j$, then they are each given an ‘average’ rank, e.g., if in attempting to assign the rank $h+1$, $k$ observations were found to have the same value, then instead of giving them the ranks
 $h+1,h+2,…,h+k,$
all $k$ observations would be assigned the rank
 $2h+k+12$
and the next value in ascending order would be assigned the rank
 $h+k+ 1.$
The process is repeated for each of the $m$ variables.
Let ${y}_{ij}$ be the rank assigned to the observation ${x}_{ij}$ when the $j$th variable is being ranked. The actual observations ${x}_{ij}$ are replaced by the ranks ${y}_{ij}$.
2. (b)Nonparametric rank correlation coefficients
1. (i)Kendall's tau:
 $Rjk=∑h=1n∑i=1nsign(yhj-yij)sign(yhk-yik) [n(n-1)-Tj][n(n-1)-Tk] , j,k=1,2,…,m,$
 where $\mathrm{sign}u=1$ if $u>0$, $\mathrm{sign}u=0$ if $u=0$, $\mathrm{sign}u=-1$ if $u<0$,
and ${T}_{j}=\sum {t}_{j}\left({t}_{j}-1\right)$, where ${t}_{j}$ is the number of ties of a particular value of variable $j$, and the summation is over all tied values of variable $j$.
2. (ii)Spearman's:
 $Rjk*=n(n2-1)-6∑i=1n (yij-yik) 2-12(Tj*+Tk*) [n(n2-1)-Tj*][n(n2-1)-Tk*] , j,k=1,2,…,m,$
where ${T}_{j}^{*}=\sum {t}_{j}\left({t}_{j}^{2}-1\right)$, ${t}_{j}$ being the number of ties of a particular value of variable $j$, and the summation being over all tied values of variable $j$.

## 4References

Siegel S (1956) Non-parametric Statistics for the Behavioral Sciences McGraw–Hill

## 5Arguments

1: $\mathbf{n}$Integer Input
On entry: $n$, the number of observations or cases.
Constraint: ${\mathbf{n}}\ge 2$.
2: $\mathbf{m}$Integer Input
On entry: $m$, the number of variables.
Constraint: ${\mathbf{m}}\ge 2$.
3: $\mathbf{x}\left({\mathbf{ldx}},{\mathbf{m}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: ${\mathbf{x}}\left(\mathit{i},\mathit{j}\right)$ must be set to ${x}_{\mathit{i}\mathit{j}}$, the value of the $\mathit{i}$th observation on the $\mathit{j}$th variable, for $\mathit{i}=1,2,\dots ,n$ and $\mathit{j}=1,2,\dots ,m$.
On exit: ${\mathbf{x}}\left(\mathit{i},\mathit{j}\right)$ contains the rank ${y}_{\mathit{i}\mathit{j}}$ of the observation ${x}_{\mathit{i}\mathit{j}}$, for $\mathit{i}=1,2,\dots ,n$ and $\mathit{j}=1,2,\dots ,m$.
4: $\mathbf{ldx}$Integer Input
On entry: the first dimension of the array x as declared in the (sub)program from which g02bnf is called.
Constraint: ${\mathbf{ldx}}\ge {\mathbf{n}}$.
5: $\mathbf{itype}$Integer Input
On entry: the type of correlation coefficients which are to be calculated.
${\mathbf{itype}}=-1$
Only Kendall's tau coefficients are calculated.
${\mathbf{itype}}=0$
Both Kendall's tau and Spearman's coefficients are calculated.
${\mathbf{itype}}=1$
Only Spearman's coefficients are calculated.
Constraint: ${\mathbf{itype}}=-1$, $0$ or $1$.
6: $\mathbf{rr}\left({\mathbf{ldrr}},{\mathbf{m}}\right)$Real (Kind=nag_wp) array Output
On exit: the requested correlation coefficients.
If only Kendall's tau coefficients are requested (${\mathbf{itype}}=-1$), ${\mathbf{rr}}\left(j,k\right)$ contains Kendall's tau for the $j$th and $k$th variables.
If only Spearman's coefficients are requested (${\mathbf{itype}}=1$), ${\mathbf{rr}}\left(j,k\right)$ contains Spearman's rank correlation coefficient for the $j$th and $k$th variables.
If both Kendall's tau and Spearman's coefficients are requested (${\mathbf{itype}}=0$), the upper triangle of rr contains the Spearman coefficients and the lower triangle the Kendall coefficients. That is, for the $\mathit{j}$th and $\mathit{k}$th variables, where $\mathit{j}$ is less than $\mathit{k}$, ${\mathbf{rr}}\left(\mathit{j},\mathit{k}\right)$ contains the Spearman rank correlation coefficient, and ${\mathbf{rr}}\left(\mathit{k},\mathit{j}\right)$ contains Kendall's tau, for $\mathit{j}=1,2,\dots ,m$ and $\mathit{k}=1,2,\dots ,m$.
(Diagonal terms, ${\mathbf{rr}}\left(j,j\right)$, are unity for all three values of itype.)
7: $\mathbf{ldrr}$Integer Input
On entry: the first dimension of the array rr as declared in the (sub)program from which g02bnf is called.
Constraint: ${\mathbf{ldrr}}\ge {\mathbf{m}}$.
8: $\mathbf{kworka}\left({\mathbf{n}}\right)$Integer array Workspace
9: $\mathbf{kworkb}\left({\mathbf{n}}\right)$Integer array Workspace
10: $\mathbf{work1}\left({\mathbf{m}}\right)$Real (Kind=nag_wp) array Workspace
11: $\mathbf{work2}\left({\mathbf{m}}\right)$Real (Kind=nag_wp) array Workspace
12: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, $-1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $-1$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $-1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-1$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
${\mathbf{ifail}}=1$
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}\ge 2$.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{m}}\ge 2$.
${\mathbf{ifail}}=3$
On entry, ${\mathbf{ldrr}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ldrr}}\ge {\mathbf{m}}$.
On entry, ${\mathbf{ldx}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ldx}}\ge {\mathbf{n}}$.
${\mathbf{ifail}}=4$
On entry, ${\mathbf{itype}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{itype}}=-1$ or $1$.
${\mathbf{ifail}}=-99$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

## 7Accuracy

The method used is believed to be stable.

## 8Parallelism and Performance

g02bnf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
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.

The time taken by g02bnf depends on $n$ and $m$.

## 10Example

This example reads in a set of data consisting of nine observations on each of three variables. 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.

### 10.1Program Text

Program Text (g02bnfe.f90)

### 10.2Program Data

Program Data (g02bnfe.d)

### 10.3Program Results

Program Results (g02bnfe.r)