-
Notifications
You must be signed in to change notification settings - Fork 75
Corr kdocs #1275
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Corr kdocs #1275
Conversation
# Conflicts: # core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/corr.kt
There was a problem hiding this 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!
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/corr.kt
Outdated
Show resolved
Hide resolved
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/corr.kt
Outdated
Show resolved
Hide resolved
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], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pearson
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missed this one
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/corr.kt
Outdated
Show resolved
Hide resolved
public fun <T, C> DataFrame<T>.corr(vararg columns: ColumnReference<C>): Corr<T, C> = corr { columns.toColumnSet() } | ||
|
||
/** | ||
* Calculates the correlation of specified [columns][otherColumns] |
There was a problem hiding this comment.
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
There was a problem hiding this 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
Closes #1020