Skip to content

Commit 71b5b57

Browse files
authored
Merge pull request #994 from Kotlin/new-csv-doc-update
Documentation mention of experimental dataframe-csv
2 parents beb0bd5 + 6b9740e commit 71b5b57

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/StardustDocs/topics/read.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,30 @@ The input string can be a file path or URL.
1919

2020
To read a CSV file, use the `.readCSV()` function.
2121

22+
> Since DataFrame v0.15, a new experimental CSV integration is available.
23+
> It is faster and more flexible than the old one, now being based on
24+
> [Deephaven CSV](https://github.com/deephaven/deephaven-csv).
25+
>
26+
> To try it in your Kotlin project, add the dependency:
27+
>
28+
> [`org.jetbrains.kotlinx:dataframe-csv:$dataframe_version`](https://central.sonatype.com/artifact/org.jetbrains.kotlinx/dataframe-csv).
29+
>
30+
> To try it in your Kotlin Notebook, modify the %use-magic directive:
31+
>
32+
> `%use dataFrame(enableExperimentalCsv=true)`.
33+
>
34+
> And then use the new `DataFrame.readCsv()` / `DataFrame.readTsv()` / `DataFrame.readDelim()`
35+
> functions over the old `DataFrame.readCSV()` ones.
36+
>
37+
> The documentation of the old CSV integration still applies to the new one.
38+
> We will expand it while the new CSV integration stabilizes.
39+
>
40+
> In the meantime, check out this
41+
> [example notebook](https://github.com/Kotlin/dataframe/blob/0.15.0/examples/notebooks/feature_overviews/0.15/new_features.ipynb)
42+
> to see the new CSV integration in action.
43+
>
44+
{style="note"}
45+
2246
To read a CSV file from a file:
2347

2448
```kotlin

0 commit comments

Comments
 (0)