Skip to content

Commit 33ff8a5

Browse files
readme updates and fixes
1 parent d0293f8 commit 33ff8a5

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

README.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Kotlin DataFrame aims to reconcile Kotlin's static typing with the dynamic natur
2020
* **Typesafe** — on-the-fly generation of extension properties for type safe data access with Kotlin-style care for null safety.
2121
* **Polymorphic** — type compatibility derives from column schema compatibility. You can define a function that requires a special subset of columns in a dataframe but doesn't care about other columns.
2222

23-
Integrates with [Kotlin kernel for Jupyter](https://github.com/Kotlin/kotlin-jupyter). Inspired by [krangl](https://github.com/holgerbrandl/krangl), Kotlin Collections and [pandas](https://pandas.pydata.org/)
23+
Integrates with [Kotlin Notebook](https://kotlinlang.org/docs/kotlin-notebook-overview.html).
24+
Inspired by [krangl](https://github.com/holgerbrandl/krangl), Kotlin Collections and [pandas](https://pandas.pydata.org/)
2425

2526
## 🚀 Quickstart
2627

@@ -30,7 +31,7 @@ Get started in minutes with our [Quickstart Guide](https://kotlin.github.io/data
3031
It walks you through the core features of Kotlin DataFrame with minimal setup and clear examples
3132
— perfect for getting up to speed in just a few minutes.
3233

33-
![quickstart_preview](docs/StardustDocs/images/guides/quickstart_preview.png)
34+
[![quickstart_preview](docs/StardustDocs/images/guides/quickstart_preview.png)](https://kotlin.github.io/dataframe/quickstart.html)
3435

3536
## Documentation
3637

@@ -62,10 +63,10 @@ Check out this [notebook with new features](examples/notebooks/feature_overviews
6263
6364
### Kotlin Notebook
6465

65-
You can use Kotlin DataFrame in [Kotlin Notebook](https://plugins.jetbrains.com/plugin/16340-kotlin-notebook),
66-
or other interactive environment with Kotlin Jupyter Kernel support, such as
67-
[Datalore](https://datalore.jetbrains.com/),
68-
and [Kotlin Jupyter](https://github.com/Kotlin/kotlin-jupyter).
66+
You can use Kotlin DataFrame in [Kotlin Notebook](https://kotlinlang.org/docs/kotlin-notebook-overview.html),
67+
or other interactive environment with [Kotlin Jupyter Kernel](https://github.com/Kotlin/kotlin-jupyter) support,
68+
such as [Datalore](https://datalore.jetbrains.com/),
69+
and [Jupyter Notebook](https://jupyter.org/).
6970

7071
You can include all the necessary dependencies and imports in the notebook using *line magic*:
7172

@@ -126,27 +127,27 @@ See also
126127

127128
```kotlin
128129
val df = DataFrame
129-
// Read DataFrame from the CSV file.
130-
.readCsv("https://raw.githubusercontent.com/Kotlin/dataframe/master/data/jetbrains_repositories.csv")
131-
// And convert it to match the `Repositories` schema.
132-
.convertTo<Repositories>()
130+
// Read DataFrame from the CSV file.
131+
.readCsv("https://raw.githubusercontent.com/Kotlin/dataframe/master/data/jetbrains_repositories.csv")
132+
// And convert it to match the `Repositories` schema.
133+
.convertTo<Repositories>()
133134

134135
// Update the DataFrame.
135136
val reposUpdated = repos
136-
// Rename columns to CamelCase.
137-
.renameToCamelCase()
138-
// Rename "stargazersCount" column to "stars".
139-
.rename { stargazersCount }.into("stars")
140-
// Filter by the number of stars:
141-
.filter { stars > 50 }
142-
// Convert values in the "topic" column (which were `String` initially)
143-
// to the list of topics.
144-
.convert { topics }.with {
145-
val inner = it.removeSurrounding("[", "]")
146-
if (inner.isEmpty()) emptyList() else inner.split(',').map(String::trim)
147-
}
148-
// Add a new column with the number of topics.
149-
.add("topicCount") { topics.size }
137+
// Rename columns to CamelCase.
138+
.renameToCamelCase()
139+
// Rename "stargazersCount" column to "stars".
140+
.rename { stargazersCount }.into("stars")
141+
// Filter by the number of stars:
142+
.filter { stars > 50 }
143+
// Convert values in the "topic" column (which were `String` initially)
144+
// to the list of topics.
145+
.convert { topics }.with {
146+
val inner = it.removeSurrounding("[", "]")
147+
if (inner.isEmpty()) emptyList() else inner.split(',').map(String::trim)
148+
}
149+
// Add a new column with the number of topics.
150+
.add("topicCount") { topics.size }
150151

151152
// Write the updated DataFrame to a CSV file.
152153
reposUpdated.writeCsv("jetbrains_repositories_new.csv")
@@ -161,7 +162,7 @@ Explore [**more examples here**](https://kotlin.github.io/dataframe/guides-and-e
161162
* `ColumnGroup` — contains columns
162163
* `FrameColumn` — contains dataframes
163164

164-
## Visualisations
165+
## Visualizations
165166

166167
[Kandy](https://kotlin.github.io/kandy/welcome.html) plotting library provides seamless visualizations
167168
for your dataframes.

0 commit comments

Comments
 (0)