Skip to content

Conversation

AndreiKingsley
Copy link
Collaborator

Closes #1020

# Conflicts:
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/corr.kt
@Jolanrensen Jolanrensen self-requested a review June 26, 2025 11:40
Copy link
Collaborator

@Jolanrensen Jolanrensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tiny notes, good docs!

public data class Corr<T, C>(internal val df: DataFrame<T>, internal val columns: ColumnsSelector<T, C>)

/**
* Computes the correlation matrix between all suitable columns in this [DataFrame],
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pearson

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missed this one

public fun <T, C> DataFrame<T>.corr(vararg columns: ColumnReference<C>): Corr<T, C> = corr { columns.toColumnSet() }

/**
* Calculates the correlation of specified [columns][otherColumns]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pearson ... represented by, same notes as above

Copy link
Collaborator

@Jolanrensen Jolanrensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please mention Pearson at least once in each entry-function of corr. There are many alternative ways to calculate correlation.
And if you fix the linter then it lgtm :)

# Conflicts:
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt
@AndreiKingsley AndreiKingsley merged commit 1e98ec9 into master Jun 27, 2025
3 checks passed
@AndreiKingsley AndreiKingsley deleted the corr_kdocs branch June 27, 2025 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add KDocs for corr
2 participants