65 lines
1.7 KiB
Markdown
Vendored
65 lines
1.7 KiB
Markdown
Vendored
# chunked
|
||
|
||
|
||
<web-summary>
|
||
Discover `chunked` operation in Kotlin Dataframe.
|
||
</web-summary>
|
||
|
||
<card-summary>
|
||
Discover `chunked` operation in Kotlin Dataframe.
|
||
</card-summary>
|
||
|
||
<link-summary>
|
||
Discover `chunked` operation in Kotlin Dataframe.
|
||
</link-summary>
|
||
|
||
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.utils.ChunkedSamples-->
|
||
|
||
Splits a [`DataFrame`](DataFrame.md) into consecutive sub-dataframes (chunks) and returns them as a
|
||
[`FrameColumn`](DataColumn.md#framecolumn). Chunks are formed in order and do not overlap.
|
||
|
||
Each chunk contains at most the specified number of rows.
|
||
The resulting `FrameColumn`’s name can be customized; by default, it is "groups."
|
||
|
||
`DataFrame` can be split into chunks in two ways:
|
||
- By fixed size: split into chunks of up to the given size.
|
||
- By start indices: split using custom zero-based start indices for each chunk; each chunk ends right before the next start index or the end of the DataFrame.
|
||
|
||
```kotlin
|
||
df.chunked(size: Int, name: String)
|
||
df.chunked(startIndices: List<Int>, name: String)
|
||
```
|
||
|
||
### Examples
|
||
|
||
<!---FUN notebook_test_chunked_1-->
|
||
|
||
```kotlin
|
||
df
|
||
```
|
||
|
||
<!---END-->
|
||
<inline-frame src="./resources/notebook_test_chunked_1.html" width="100%" height="500px"></inline-frame>
|
||
|
||
Fixed size chunks:
|
||
<!---FUN notebook_test_chunked_2-->
|
||
|
||
```kotlin
|
||
df.chunked(size = 2)
|
||
```
|
||
|
||
<!---END-->
|
||
|
||
<inline-frame src="./resources/notebook_test_chunked_2.html" width="100%" height="500px"></inline-frame>
|
||
|
||
Custom start indices:
|
||
<!---FUN notebook_test_chunked_3-->
|
||
|
||
```kotlin
|
||
df.chunked(startIndices = listOf(0, 1, 3), name = "segments")
|
||
```
|
||
|
||
<!---END-->
|
||
|
||
<inline-frame src="./resources/notebook_test_chunked_3.html" width="100%" height="500px"></inline-frame>
|