Skip to content

Commit 1bb565b

Browse files
committed
Remove some of the outdated info from README.md
1 parent 3482b12 commit 1bb565b

File tree

1 file changed

+2
-60
lines changed

1 file changed

+2
-60
lines changed

README.md

Lines changed: 2 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -43,21 +43,12 @@ You could find the following articles there:
4343

4444
Check out this [notebook with new features](examples/notebooks/feature_overviews/0.15/new_features.ipynb) in v0.15.
4545

46-
The DataFrame compiler plugin has reached public preview!
47-
Here's a [compiler plugin demo project](https://github.com/koperagen/df-plugin-demo) that works with [IntelliJ IDEA](https://www.jetbrains.com/idea/) 2024.2.
48-
4946
## Setup
5047

5148
```kotlin
5249
implementation("org.jetbrains.kotlinx:dataframe:1.0.0-Beta2")
5350
```
5451

55-
Optional Gradle plugin for enhanced type safety and schema generation
56-
https://kotlin.github.io/dataframe/schemasgradle.html
57-
```kotlin
58-
id("org.jetbrains.kotlinx.dataframe") version "1.0.0-Beta2"
59-
```
60-
6152
Check out the [custom setup page](https://kotlin.github.io/dataframe/gettingstartedgradleadvanced.html) if you don't need some of the formats as dependencies,
6253
for Groovy, and for configurations specific to Android projects.
6354

@@ -76,58 +67,9 @@ df["full_name"][0] // Indexing https://kotlin.github.io/dataframe/access.html
7667
df.filter { "stargazers_count"<Int>() > 50 }.print()
7768
```
7869

79-
## Getting started with data schema
80-
81-
Requires Gradle plugin to work
82-
```kotlin
83-
id("org.jetbrains.kotlinx.dataframe") version "1.0.0-Beta2"
84-
```
85-
86-
Plugin generates extension properties API for provided sample of data. Column names and their types become discoverable in completion.
87-
88-
```kotlin
89-
// Make sure to place the file annotation above the package directive
90-
@file:ImportDataSchema(
91-
"Repository",
92-
"https://raw.githubusercontent.com/Kotlin/dataframe/master/data/jetbrains_repositories.csv",
93-
)
94-
95-
package example
96-
97-
import org.jetbrains.kotlinx.dataframe.annotations.ImportDataSchema
98-
import org.jetbrains.kotlinx.dataframe.api.*
99-
100-
fun main() {
101-
// execute `assemble` to generate extension properties API
102-
val df = Repository.readCSV()
103-
df.fullName[0]
104-
105-
df.filter { stargazersCount > 50 }
106-
}
107-
```
108-
109-
## Getting started in Jupyter Notebook / Kotlin Notebook
110-
111-
Install the [Kotlin kernel](https://github.com/Kotlin/kotlin-jupyter) for [Jupyter](https://jupyter.org/)
112-
113-
Import the stable `dataframe` version into a notebook:
114-
```
115-
%use dataframe
116-
```
117-
or a specific version:
118-
```
119-
%use dataframe(<version>)
120-
```
121-
122-
```kotlin
123-
val df = DataFrame.read("https://raw.githubusercontent.com/Kotlin/dataframe/master/data/jetbrains_repositories.csv")
124-
df // the last expression in the cell is displayed
125-
```
70+
## Getting started in Kotlin Notebook
12671

127-
When a cell with a variable declaration is executed, in the next cell `DataFrame` provides extension properties based on its data
128-
```kotlin
129-
df.filter { stargazers_count > 50 }
130-
```
72+
Follow this [guide](https://kotlin.github.io/dataframe/gettingstartedkotlinnotebook.html)
13173

13274
## Data model
13375
* `DataFrame` is a list of columns with equal sizes and distinct names.

0 commit comments

Comments
 (0)