marked aggregateBy for removal

Author: Jolanrensen

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/impl/aggregation/aggregators/Aggregator.kt

@@ -53,7 +53,7 @@ internal interface Aggregator<in Value, out Return> {
 
     /**
      * Special case of [aggregate] with [Iterable] that calculates the common type of the values at runtime.
-     * This is a heavy operation and should be avoided when possible.
+     * Without [valueTypes], this is a heavy operation and should be avoided when possible.
      *
      * @param values The values to be aggregated.
      * @param valueTypes The types of the values.

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/impl/aggregation/aggregators/TwoStepNumbersAggregator.kt

@@ -114,7 +114,7 @@ internal class TwoStepNumbersAggregator<out Return : Number>(
     /**
      * Special case of [aggregate] with [Iterable] that calculates the [unified number type][UnifyingNumbers]
      * of the values at runtime and converts all numbers to this type before aggregating.
-     * This is a heavy operation and should be avoided when possible.
+     * Without [valueTypes], this is a heavy operation and should be avoided when possible.
      *
      * @param values The numbers to be aggregated.
      * @param valueTypes The types of the numbers.

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/impl/aggregation/modes/aggregateBy.kt

@@ -3,12 +3,14 @@ package org.jetbrains.kotlinx.dataframe.impl.aggregation.modes
 import org.jetbrains.kotlinx.dataframe.DataFrame
 import org.jetbrains.kotlinx.dataframe.DataFrameExpression
 import org.jetbrains.kotlinx.dataframe.DataRow
+import org.jetbrains.kotlinx.dataframe.annotations.CandidateForRemoval
 import org.jetbrains.kotlinx.dataframe.api.GroupBy
 import org.jetbrains.kotlinx.dataframe.api.Grouped
 import org.jetbrains.kotlinx.dataframe.api.cast
 import org.jetbrains.kotlinx.dataframe.impl.aggregation.aggregateInternal
 import org.jetbrains.kotlinx.dataframe.impl.namedValues
 
+@CandidateForRemoval
 internal fun <T> Grouped<T>.aggregateBy(body: DataFrameExpression<T, DataRow<T>?>): DataFrame<T> {
     require(this is GroupBy<*, T>)
     val keyColumns = keys.columnNames().toSet()