NAG FL Interfaceg02bhf (coeffs_​pearson_​subset_​miss_​case)

1Purpose

g02bhf computes means and standard deviations, sums of squares and cross-products of deviations from means, and Pearson product-moment correlation coefficients for selected variables omitting completely any cases with a missing observation for any variable (either over all variables in the dataset or over only those variables in the selected subset).

2Specification

Fortran Interface
 Subroutine g02bhf ( n, m, x, ldx, miss, kvar, xbar, std, ssp, r, ldr,
 Integer, Intent (In) :: n, m, ldx, mistyp, nvars, kvar(nvars), ldssp, ldr Integer, Intent (Inout) :: miss(m), ifail Integer, Intent (Out) :: ncases Real (Kind=nag_wp), Intent (In) :: x(ldx,m) Real (Kind=nag_wp), Intent (Inout) :: xmiss(m), ssp(ldssp,nvars), r(ldr,nvars) Real (Kind=nag_wp), Intent (Out) :: xbar(nvars), std(nvars)
#include <nag.h>
 void g02bhf_ (const Integer *n, const Integer *m, const double x[], const Integer *ldx, Integer miss[], double xmiss[], const Integer *mistyp, const Integer *nvars, const Integer kvar[], double xbar[], double std[], double ssp[], const Integer *ldssp, double r[], const Integer *ldr, Integer *ncases, Integer *ifail)
The routine may be called by the names g02bhf or nagf_correg_coeffs_pearson_subset_miss_case.

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 on the $j$th variable, together with the subset of these variables, ${v}_{1},{v}_{2},\dots ,{v}_{p}$, for which information is required.
In addition, each of the $m$ 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 $j$th variable is denoted by ${\mathit{xm}}_{j}$. Missing values need not be specified for all variables. The missing values can be utilized in two slightly different ways; you can indicate which scheme is required.
Firstly, let ${w}_{i}=0$ if observation $i$ contains a missing value for any of those variables in the set $1,2,\dots ,m$ for which missing values have been declared, i.e., if ${x}_{ij}={\mathit{xm}}_{j}$ for any $j$ ($j=1,2,\dots ,m$) for which an ${\mathit{xm}}_{j}$ has been assigned (see also Section 7); and ${w}_{i}=1$ otherwise, for $\mathit{i}=1,2,\dots ,n$.
Secondly, let ${w}_{i}=0$ if observation $i$ contains a missing value for any of those variables in the selected subset ${v}_{1},{v}_{2},\dots ,{v}_{p}$ for which missing values have been declared, i.e., if ${x}_{ij}={\mathit{xm}}_{j}$ for any $j$ ($j={v}_{1},{v}_{2},\dots ,{v}_{p}$) for which an ${\mathit{xm}}_{j}$ has been assigned (see also Section 7); and ${w}_{i}=1$ otherwise, for $\mathit{i}=1,2,\dots ,n$.
The quantities calculated are:
1. (a)Means:
 $x¯j=∑i=1nwixij ∑i=1nwi , j=v1,v2,…,vp.$
2. (b)Standard deviations:
 $sj= ∑i= 1nwi xij-x¯j 2 ∑i= 1nwi- 1 , j=v1,v2,…,vp.$
3. (c)Sums of squares and cross-products of deviations from means:
 $Sjk=∑i=1nwixij-x¯jxik-x¯k, j,k=v1,v2,…,vp.$
4. (d)Pearson product-moment correlation coefficients:
 $Rjk=SjkSjjSkk , j,k=v1,v2,…,vp.$
If ${S}_{jj}$ or ${S}_{kk}$ is zero, ${R}_{jk}$ is set to zero.

None.

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
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$.
4: $\mathbf{ldx}$Integer Input
On entry: the first dimension of the array x as declared in the (sub)program from which g02bhf is called.
Constraint: ${\mathbf{ldx}}\ge {\mathbf{n}}$.
5: $\mathbf{miss}\left({\mathbf{m}}\right)$Integer array Input/Output
On entry: ${\mathbf{miss}}\left(j\right)$ must be set equal to $1$ if a missing value, $x{m}_{j}$, is to be specified for the $j$th variable in the array x, or set equal to $0$ otherwise. Values of miss must be given for all $m$ variables in the array x.
On exit: the array miss is overwritten by the routine, and the information it contained on entry is lost.
6: $\mathbf{xmiss}\left({\mathbf{m}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: ${\mathbf{xmiss}}\left(j\right)$ must be set to the missing value, $x{m}_{j}$, to be associated with the $j$th variable in the array x, for those variables for which missing values are specified by means of the array miss (see Section 7).
On exit: the array xmiss is overwritten by the routine, and the information it contained on entry is lost.
7: $\mathbf{mistyp}$Integer Input
On entry: indicates the manner in which missing observations are to be treated.
${\mathbf{mistyp}}=1$
A case is excluded if it contains a missing value for any of the variables $1,2,\dots ,m$.
${\mathbf{mistyp}}=0$
A case is excluded if it contains a missing value for any of the $p\left(\le m\right)$ variables specified in the array kvar.
8: $\mathbf{nvars}$Integer Input
On entry: $p$, the number of variables for which information is required.
Constraint: $2\le {\mathbf{nvars}}\le {\mathbf{m}}$.
9: $\mathbf{kvar}\left({\mathbf{nvars}}\right)$Integer array Input
On entry: ${\mathbf{kvar}}\left(\mathit{j}\right)$ must be set to the column number in x of the $\mathit{j}$th variable for which information is required, for $\mathit{j}=1,2,\dots ,p$.
Constraint: $1\le {\mathbf{kvar}}\left(\mathit{j}\right)\le {\mathbf{m}}$, for $\mathit{j}=1,2,\dots ,p$.
10: $\mathbf{xbar}\left({\mathbf{nvars}}\right)$Real (Kind=nag_wp) array Output
On exit: the mean value, of ${\overline{x}}_{\mathit{j}}$, of the variable specified in ${\mathbf{kvar}}\left(\mathit{j}\right)$, for $\mathit{j}=1,2,\dots ,p$.
11: $\mathbf{std}\left({\mathbf{nvars}}\right)$Real (Kind=nag_wp) array Output
On exit: the standard deviation, ${s}_{\mathit{j}}$, of the variable specified in ${\mathbf{kvar}}\left(\mathit{j}\right)$, for $\mathit{j}=1,2,\dots ,p$.
12: $\mathbf{ssp}\left({\mathbf{ldssp}},{\mathbf{nvars}}\right)$Real (Kind=nag_wp) array Output
On exit: ${\mathbf{ssp}}\left(\mathit{j},\mathit{k}\right)$ is the cross-product of deviations, ${S}_{\mathit{j}\mathit{k}}$, for the variables specified in ${\mathbf{kvar}}\left(\mathit{j}\right)$ and ${\mathbf{kvar}}\left(\mathit{k}\right)$, for $\mathit{j}=1,2,\dots ,p$ and $\mathit{k}=1,2,\dots ,p$.
13: $\mathbf{ldssp}$Integer Input
On entry: the first dimension of the array ssp as declared in the (sub)program from which g02bhf is called.
Constraint: ${\mathbf{ldssp}}\ge {\mathbf{nvars}}$.
14: $\mathbf{r}\left({\mathbf{ldr}},{\mathbf{nvars}}\right)$Real (Kind=nag_wp) array Output
On exit: ${\mathbf{r}}\left(\mathit{j},\mathit{k}\right)$ is the product-moment correlation coefficient, ${R}_{\mathit{j}\mathit{k}}$, between the variables specified in ${\mathbf{kvar}}\left(\mathit{j}\right)$ and ${\mathbf{kvar}}\left(\mathit{k}\right)$, for $\mathit{j}=1,2,\dots ,p$ and $\mathit{k}=1,2,\dots ,p$.
15: $\mathbf{ldr}$Integer Input
On entry: the first dimension of the array r as declared in the (sub)program from which g02bhf is called.
Constraint: ${\mathbf{ldr}}\ge {\mathbf{nvars}}$.
16: $\mathbf{ncases}$Integer Output
On exit: the number of cases actually used in the calculations (when cases involving missing values have been eliminated).
17: $\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{nvars}}=〈\mathit{\text{value}}〉$ and ${\mathbf{m}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{nvars}}\ge 2$ and ${\mathbf{nvars}}\le {\mathbf{m}}$.
${\mathbf{ifail}}=3$
On entry, ${\mathbf{ldr}}=〈\mathit{\text{value}}〉$ and ${\mathbf{nvars}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{ldr}}\ge {\mathbf{nvars}}$.
On entry, ${\mathbf{ldssp}}=〈\mathit{\text{value}}〉$ and ${\mathbf{nvars}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{ldssp}}\ge {\mathbf{nvars}}$.
On entry, ${\mathbf{ldx}}=〈\mathit{\text{value}}〉$ and ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{ldx}}\ge {\mathbf{n}}$.
${\mathbf{ifail}}=4$
On entry, $\mathit{i}=〈\mathit{\text{value}}〉$, ${\mathbf{kvar}}\left(\mathit{i}\right)=〈\mathit{\text{value}}〉$ and ${\mathbf{m}}=〈\mathit{\text{value}}〉$.
Constraint: $1\le {\mathbf{kvar}}\left(\mathit{i}\right)\le {\mathbf{m}}$.
${\mathbf{ifail}}=5$
On entry, ${\mathbf{mistyp}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{mistyp}}=0$ or $1$.
${\mathbf{ifail}}=6$
After observations with missing values were omitted, no cases remained.
${\mathbf{ifail}}=7$
After observations with missing values were omitted, only one case remained.
${\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

g02bhf does not use additional precision arithmetic for the accumulation of scalar products, so there may be a loss of significant figures for large $n$.
You are warned of the need to exercise extreme care in your selection of missing values. g02bhf treats all values in the inclusive range $\left(1±{0.1}^{\left({\mathbf{x02bef}}-2\right)}\right)×{xm}_{j}$, where ${\mathit{xm}}_{j}$ is the missing value for variable $j$ 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.

8Parallelism and Performance

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

The time taken by g02bhf depends on $n$ and $p$, and the occurrence of missing values.
The routine uses a two-pass algorithm.

9.1Internal Changes

Internal changes have been made to this routine as follows:
• At Mark 27: The algorithm underlying this routine has been altered to improve efficiency for large problem sizes on a multi-threaded system.
For details of all known issues which have been reported for the NAG Library please refer to the Known Issues.

10Example

This example reads in a set of data consisting of five observations on each of four variables. Missing values of $0.0$ are declared for the second and fourth variables; no missing values are specified for the first and third variables. The means, standard deviations, sums of squares and cross-products of deviations from means, and Pearson product-moment correlation coefficients for the fourth, first and second variables are then calculated and printed, omitting completely all cases containing missing values for these three selected variables; cases $3$ and $4$ are therefore eliminated, leaving only three cases in the calculations.

10.1Program Text

Program Text (g02bhfe.f90)

10.2Program Data

Program Data (g02bhfe.d)

10.3Program Results

Program Results (g02bhfe.r)