Skip to content

Commit 0ad2463

Browse files
corr kdocs Pearson mention
1 parent df16ffd commit 0ad2463

File tree

1 file changed

+2
-2
lines changed
  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api

1 file changed

+2
-2
lines changed

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/corr.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ internal fun AnyCol.isSuitableForCorr() = isSubtypeOf<Number>() || type() == typ
112112
public data class Corr<T, C>(internal val df: DataFrame<T>, internal val columns: ColumnsSelector<T, C>)
113113

114114
/**
115-
* Computes the correlation matrix between all suitable columns in this [DataFrame],
115+
* Computes the pearson correlation between all suitable columns in this [DataFrame],
116116
* including nested columns at any depth.
117117
*
118118
* The result is a square correlation matrix represented by a [DataFrame],
@@ -262,7 +262,7 @@ public fun <T, C, R> Corr<T, C>.with(vararg otherColumns: ColumnReference<R>): D
262262
with { otherColumns.toColumnSet() }
263263

264264
/**
265-
* Calculates pairwise correlations between the columns
265+
* Calculates Pearson pairwise correlations between the columns
266266
* previously selected with [corr].
267267
*
268268
* Returns a square correlation matrix represented by a [DataFrame],

0 commit comments

Comments
 (0)