corr (DataFrameStatFunctions)

Calculates the correlation of two columns of a DataFrame as a double value. Currently only supports the Pearson Correlation Coefficient. DataFrame.corr and DataFrameStatFunctions.corr are aliases of each other.

Syntax

corr(col1, col2, method=None)

Parameters

Parameter	Type	Description
col1	str	The name of the first column.
col2	str	The name of the second column.
method	str, optional	The correlation method. Currently only supports "pearson".

Parameter	Type	Description
col1	str	The name of the first column.
col2	str	The name of the second column.
method	str, optional	The correlation method. Currently only supports "pearson".

Returns

float

Examples

Python

df = spark.createDataFrame([(1, 12), (10, 1), (19, 8)], ["c1", "c2"])
df.stat.corr("c1", "c2")
# -0.3592106040535498

df = spark.createDataFrame([(11, 12), (10, 11), (9, 10)], ["small", "bigger"])
df.stat.corr("small", "bigger")
# 1.0