Skip to content

Commit 41462db

Browse files
committed
Add plugin annotations for corr, cumSum, asFrame
1 parent 0ef1b37 commit 41462db

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,8 @@ public inline fun <T, C, reified R> Convert<T, C>.with(
453453
*
454454
* @param [expression] The {@include [ExpressionsGivenDataFrame.DataFrameExpressionLink]} to replace the selected column group with.
455455
*/
456+
@Refine
457+
@Interpretable("ConvertAsFrame")
456458
public fun <T, C, R> Convert<T, DataRow<C>>.asFrame(
457459
expression: ColumnsContainer<T>.(ColumnGroup<C>) -> DataFrame<R>,
458460
): DataFrame<T> = asColumn { expression(this, it.asColumnGroup()).asColumnGroup(it.name()) }

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ import org.jetbrains.kotlinx.dataframe.AnyCol
44
import org.jetbrains.kotlinx.dataframe.ColumnsSelector
55
import org.jetbrains.kotlinx.dataframe.DataFrame
66
import org.jetbrains.kotlinx.dataframe.annotations.AccessApiOverload
7+
import org.jetbrains.kotlinx.dataframe.annotations.Interpretable
8+
import org.jetbrains.kotlinx.dataframe.annotations.Refine
79
import org.jetbrains.kotlinx.dataframe.api.CorrDocs.Grammar
810
import org.jetbrains.kotlinx.dataframe.api.CorrDocs.SelectingOptions
911
import org.jetbrains.kotlinx.dataframe.columns.ColumnGroup
@@ -127,6 +129,8 @@ public data class Corr<T, C>(internal val df: DataFrame<T>, internal val columns
127129
*
128130
* @return A square correlation matrix as a [DataFrame], where both rows and columns correspond to the original columns.
129131
*/
132+
@Refine
133+
@Interpretable("DataFrameCorr")
130134
public fun <T> DataFrame<T>.corr(): DataFrame<T> =
131135
corr {
132136
colsAtAnyDepth().filter { it.isSuitableForCorr() }

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ import org.jetbrains.kotlinx.dataframe.ColumnsSelector
44
import org.jetbrains.kotlinx.dataframe.DataColumn
55
import org.jetbrains.kotlinx.dataframe.DataFrame
66
import org.jetbrains.kotlinx.dataframe.annotations.AccessApiOverload
7+
import org.jetbrains.kotlinx.dataframe.annotations.Interpretable
8+
import org.jetbrains.kotlinx.dataframe.annotations.Refine
79
import org.jetbrains.kotlinx.dataframe.api.Select.SelectSelectingOptions
810
import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
911
import org.jetbrains.kotlinx.dataframe.columns.toColumnSet
@@ -114,6 +116,8 @@ public fun <T : Number?> DataColumn<T>.cumSum(skipNA: Boolean = defaultCumSumSki
114116
* {@include [CumSumDocs]}
115117
* {@set [CumSumDocs.DATA_TYPE] [DataFrame]}
116118
*/
119+
@Refine
120+
@Interpretable("DataFrameCumSum")
117121
public fun <T, C : Number?> DataFrame<T>.cumSum(
118122
skipNA: Boolean = defaultCumSumSkipNA,
119123
columns: ColumnsSelector<T, C>,
@@ -167,6 +171,8 @@ public fun <T> DataFrame<T>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataF
167171
* {@include [CumSumDocs]}
168172
* {@set [CumSumDocs.DATA_TYPE] [GroupBy]}
169173
*/
174+
@Refine
175+
@Interpretable("GroupByCumSum")
170176
public fun <T, G, C : Number?> GroupBy<T, G>.cumSum(
171177
skipNA: Boolean = defaultCumSumSkipNA,
172178
columns: ColumnsSelector<G, C>,

0 commit comments

Comments
 (0)