naginterfaces.library.correg.coeffs_​zero_​subset_​miss_​pair

naginterfaces.library.correg.coeffs_zero_subset_miss_pair(x, miss, xmiss, kvar)

coeffs_zero_subset_miss_pair computes means and standard deviations, sums of squares and cross-products about zero, and correlation-like coefficients for selected variables omitting cases with missing values from only those calculations involving the variables for which the values are missing.

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

https://support.nag.com/numeric/nl/nagdoc_30/flhtml/g02/g02bmf.html

Parameters

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

$x[\text{i}-1,\text{j}-1]$ must be set to $x_{\text{i}\text{j}}$, the value of the $\text{i}$th observation on the $\text{j}$th variable, for $\text{j}=1,2,\dots ,m$, for $\text{i}=1,2,\dots ,n$.

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

$miss[j-1]$ 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$.

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

$xmiss[j-1]$ 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 Accuracy).

kvarint, array-like, shape $\left(\text{nvars}\right)$

$kvar\left[\text{j}\right]$ must be set to the column number in $x$ of the $\text{j}$th variable for which information is required, for $\text{j}=0,\dots ,p-1$.

Returns

xbarfloat, ndarray, shape $\left(\text{nvars}\right)$

The mean value, ${\overline{x}}_{\text{j}}$, of the variable specified in $kvar[\text{j}-1]$, for $\text{j}=1,2,\dots ,p$.

stdfloat, ndarray, shape $\left(\text{nvars}\right)$

The standard deviation, $s_{\text{j}}$, of the variable specified in $kvar[\text{j}-1]$, for $\text{j}=1,2,\dots ,p$.

sspzfloat, ndarray, shape $(\text{nvars},\text{nvars})$

$sspz[\text{j}-1,\text{k}-1]$ is the cross-product about zero, ${\tilde{S}}_{\text{j}\text{k}}$, for the variables specified in $kvar[\text{j}-1]$ and $kvar[\text{k}-1]$, for $\text{k}=1,2,\dots ,p$, for $\text{j}=1,2,\dots ,p$.

rzfloat, ndarray, shape $(\text{nvars},\text{nvars})$

$rz[\text{j}-1,\text{k}-1]$ is the correlation-like coefficient, ${\tilde{R}}_{\text{j}\text{k}}$, between the variables specified in $kvar[\text{j}-1]$ and $kvar[\text{k}-1]$, for $\text{k}=1,2,\dots ,p$, for $\text{j}=1,2,\dots ,p$.

ncasesint

The minimum number of cases used in the calculation of any of the sums of squares and cross-products and correlation-like coefficients (when cases involving missing values have been eliminated).

cntfloat, ndarray, shape $(\text{nvars},\text{nvars})$

$cnt[\text{j}-1,\text{k}-1]$ is the number of cases, $c_{\text{j}\text{k}}$, actually used in the calculation of the sum of cross-product and correlation-like coefficient for the variables specified in $kvar[\text{j}-1]$ and $kvar[\text{k}-1]$, for $\text{k}=1,2,\dots ,p$, for $\text{j}=1,2,\dots ,p$.

Raises

NagValueError

(errno $1$)

On entry, $n=⟨value⟩$.

Constraint: $n\ge 2$.

(errno $2$)

On entry, $\text{nvars}=⟨value⟩$ and $m=⟨value⟩$.

Constraint: $\text{nvars}\ge 2$ and $\text{nvars}\le m$.

(errno $4$)

On entry, $\text{i}=⟨value⟩$, $kvar[\text{i}-1]=⟨value⟩$ and $m=⟨value⟩$.

Constraint: $1\le kvar[\text{i}-1]\le m$.

Warns

NagAlgorithmicWarning

(errno $5$)

After observations with missing values were omitted, fewer than two cases remained for at least one pair of variables. (The pairs of variables involved can be determined by examination of the contents of the array $cnt$). All means, standard deviations, sums of squares and cross-products, and correlation-like coefficients based on two or more cases are returned by the function even if $errno$ = 5.

Notes

No equivalent traditional C interface for this routine exists in the NAG Library.

The input data consists of $n$ observations for each of $m$ variables, given as an array

$$\left[x_{ij}\right]\text{,}i=1,2,\dots ,n(n\ge 2),j=1,2,\dots ,m(m\ge 2)\text{,}$$

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 ${\text{xm}}_j$. Missing values need not be specified for all variables.

Let $w_{\text{i}\text{j}}=0$, if the $\text{i}$th observation for the $\text{j}$th variable is a missing value, i.e., if a missing value, ${\text{xm}}_{\text{j}}$, has been declared for the $\text{j}$th variable, and $x_{\text{i}\text{j}}={\text{xm}}_{\text{j}}$ (see also Accuracy); and $w_{\text{i}\text{j}}=1$ otherwise, for $\text{j}=1,2,\dots ,m$, for $\text{i}=1,2,\dots ,n$.

The quantities calculated are:

1. Means:

   $${\overline{x}}_j=\frac{{\sum }_{i=1}^n{w}_{ij}{x}_{ij}}{{\sum }_{i=1}^n{w}_{ij}}\text{,}j=v_1,v_2,\dots ,v_p\text{.}$$

2. Standard deviations:

   $$s_j=\sqrt{\frac{{\sum }_{i=1}^n{w}_{ij}{(x_{ij}-{\overline{x}}_j)}^2}{{\sum }_{i=1}^n{w}_{ij}-1}}\text{,}j=v_1,v_2,\dots ,v_p\text{.}$$

3. Sums of squares and cross-products about zero:

   $${\tilde{S}}_{jk}=\sum _{i=1}^n{w}_{ij}{w}_{ik}{x}_{ij}{x}_{ik}\text{,}j,k=v_1,v_2,\dots ,v_p\text{.}$$

4. Correlation-like coefficients:

   $${\tilde{R}}_{jk}=\frac{{\tilde{S}}_{jk}}{\sqrt{{\tilde{S}}_{jj\left(k\right)}{\tilde{S}}_{kk\left(j\right)}}}\text{,}j,k=v_{1,}{v}_2,\dots ,v_p\text{,}$$

   where ${\tilde{S}}_{jj\left(k\right)}={\sum }_{i=1}^n{w}_{ij}{w}_{ik}{x}_{ij}^2$ and ${\tilde{S}}_{kk\left(j\right)}={\sum }_{i=1}^n{w}_{ik}{w}_{ij}{x}_{ik}^2$

   (i.e., the sums of squares about zero are based on the same set of observations as are used in the calculation of the numerator).

   If ${\tilde{S}}_{jj\left(k\right)}$ or ${\tilde{S}}_{kk\left(j\right)}$ is zero, ${\tilde{R}}_{jk}$ is set to zero.

5. The number of cases used in the calculation of each of the correlation-like coefficients:

   $$c_{jk}=\sum _{i=1}^n{w}_{ij}{w}_{ik}\text{,}j,k=v_1,v_2,\dots ,v_p\text{.}$$

   (The diagonal terms, $c_{\text{j}\text{j}}$, for $\text{j}=1,2,\dots ,n$, also give the number of cases used in the calculation of the means ${\overline{x}}_{\text{j}}$ and the standard deviations $s_{\text{j}}$.)