StatCorrelation (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Calculating the coefficient of correlation
Number of elements found in the matrix
Managing the errors

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

StatCorrelation (Function)

In french: StatCorrelation

Calculates the coefficient of correlation between two series of values.

Versions 25 and later

This function is now available in browser code.

New in version 25

This function is now available in browser code.

Example

See additional examples

// Calculate the coefficient of correlation between row 1 and row 2 of a matrix
ResCorrelationCoef = StatCorrelation("MyMatrix", 1, 2, False)

Syntax

<Result> = StatCorrelation(<Matrix> [, <1st row/1st column> [, <2nd row/2nd column> [, <Row/Column>]]])

<Result>: Real

Coefficient of correlation that exist between the two series of values,
0 if the coefficient of correlation is null.

<Matrix>: Character string (with quotes)

Name of the matrix containing the data, defined by MatCreate.

<1st row/1st column>: Optional integer

1st row or 1st column containing the data (1 by default).

<2nd row/2nd column>: Optional integer

2nd row or 2nd column containing the data (2 by default).

<Row/Column>: Optional boolean

True (by default) if the series of values correspond to matrix columns,
False if the series of values correspond to matrix rows.

Remarks

Calculating the coefficient of correlation

StatCorrelation("MyMatrix", 1, 3, False) returns 0,997054.

StatCorrelation("MyMatrix", 1, 3, False) returns 1.

StatCorrelation("MyMatrix", 1, 3, False) returns 0.

Number of elements found in the matrix

The number of elements found in the matrix is taken as reference. This number of elements corresponds to:

the number of matrix rows, returned by MatNbLine.
the number of matrix columns, returned by MatNbColumn.

If the series contain less elements than the matrix, the missing values are automatically filled with 0. These values are taken into account during the calculations.

Managing the errors

Caution: StatCorrelation returns no error code. To find out whether errors have been generated when calculating the coefficient of correlation, use StatError. To find out the error details, use ErrorInfo associated with the errMessage constant.

Related Examples:

Unit examples (WINDEV): The Stat functions

[ + ] Using the main functions for statistical calculations (using matrices):
- Calculate a sum of values
- Calculate a mean of values
- Find the minimum value in a set of values
- Find the maximum value in a set of values

Unit examples (WINDEV Mobile): The Stat functions

Business / UI classification : Neutral code

Component : wd250mat.dll