Skip to content

Commit 88dea91

Browse files
Merge pull request #1179 from Kotlin/website_docs_examples_dev
Website docs examples dev
2 parents eddfdfc + a3e3e8c commit 88dea91

File tree

3 files changed

+54
-5
lines changed

3 files changed

+54
-5
lines changed

docs/StardustDocs/d.tree

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,6 @@
196196
<toc-element topic="Usage-with-Kotlin-Notebook-Plugin.md">
197197
<toc-element topic="Trobleshooting.md"/>
198198
</toc-element>
199-
<toc-element href="https://github.com/Kotlin/dataframe/tree/master/examples" toc-title="Examples"/>
200199
<toc-element topic="Compiler-Plugin.md"/>
201200
<toc-element topic="_shadow_resources.md" hidden="true"/>
202201
<toc-element topic="_shadow_resources_snippets.md" hidden="true"/>

docs/StardustDocs/topics/_shadow_resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99
<resource src="notebook_test_quickstart_5.html"></resource>
1010
<resource src="notebook_test_quickstart_12.html"></resource>
1111
<resource src="notebook_test_quickstart_3.html"></resource>
12-
<resource src="notebook_test_quickstart_14.html"></resource>
12+
<resource src="notebook_test_quickstart_14.html"></resource>

docs/StardustDocs/topics/guides/Guides-And-Examples.md

Lines changed: 53 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,72 @@ Browse a collection of guides and examples covering key features and real-world
55
</web-summary>
66

77
<card-summary>
8-
Explore Kotlin DataFrame with user guides and real-world examples,
8+
Explore Kotlin DataFrame with detailed user guides and real-world examples,
99
showcasing practical use cases and data workflows.
1010
</card-summary>
1111

1212
<link-summary>
1313
A curated list of Kotlin DataFrame guides and examples that walk you through common operations and data analysis patterns step by step.
1414
</link-summary>
1515

16+
<!--- TODO: add more guides (migration from pandas and others) and replace GH notebooks with topics --->
1617

1718
## Guides
1819

20+
Explore our structured, in-depth guides to steadily improve your Kotlin DataFrame skills — step by step.
21+
1922
* [Quickstart Guide](quickstart.md) — get started with Kotlin DataFrame in a few simple steps:
2023
load data, transform it, and visualize it.
24+
* [Enhanced Column Selection DSL](https://blog.jetbrains.com/kotlin/2024/07/enhanced-column-selection-dsl-in-kotlin-dataframe/)
25+
— explore powerful DSL for typesafe and flexible column selection in Kotlin DataFrame.
26+
* [40 Puzzles](https://github.com/Kotlin/dataframe/blob/master/examples/notebooks/puzzles/40%20puzzles.ipynb)
27+
— inspired by [100 pandas puzzles](https://github.com/ajcr/100-pandas-puzzles).
28+
An interactive guide that takes you from simple tasks to complex challenges,
29+
teaching you how to solve them using Kotlin DataFrame in a concise and elegant style.
30+
* [SQL Databases Interaction](readSqlDatabases.md)
31+
— set up SQL database access and read query results efficiently into `DataFrame`.
32+
* [GeoDataFrame Guide](https://kotlin.github.io/kandy/geo-plotting-guide.html)
33+
— explore the GeoDataFrame module that brings a convenient Kotlin DataFrame API to geospatial workflows,
34+
enhanced with beautiful Kandy-Geo visualizations (*experimental*).
35+
* [OpenAPI Guide](https://github.com/Kotlin/dataframe/blob/master/examples/notebooks/json/KeyValueAndOpenApi.ipynb)
36+
— learn how to parse and explore [OpenAPI](https://swagger.io) JSON structures using Kotlin DataFrame,
37+
enabling structured access and intuitive analysis of complex API schemas (*experimental*, supports OpenAPI 3.0.0).
2138

22-
<!--- TODO: add more guides. --->
2339

2440
## Examples
2541

26-
* [Titanic](titanic.md)
42+
Explore our extensive collection of practical examples and real-world analytics workflows.
43+
44+
* [Titanic Example](https://github.com/Kotlin/dataframe/blob/master/examples/notebooks/titanic/Titanic.ipynb)
45+
— discover the famous "Titanic"
46+
dataset with the Kotlin DataFrame analysis toolkit
47+
and [Kandy](https://kotlin.github.io/kandy/) visualizations.
48+
49+
* [Track and Analyze GitHub Star Growth](https://blog.jetbrains.com/kotlin/2024/08/track-and-analyze-github-star-growth-with-kandy-and-kotlin-dataframe/)
50+
— query GitHub’s API with the Kotlin Notebook Ktor client,
51+
then analyze and visualize the data using Kotlin DataFrame and [Kandy](https://kotlin.github.io/kandy/).
52+
53+
* [GitHub Example](https://github.com/Kotlin/dataframe/blob/master/examples/notebooks/github/github.ipynb)
54+
— a practical example of working with deeply nested, hierarchical DataFrames using GitHub data.
55+
56+
* [Netflix Example](https://github.com/Kotlin/dataframe/blob/master/examples/notebooks/netflix/netflix.ipynb)
57+
— explore TV shows and movies from Netflix with the powerful Kotlin Dataframe API and beautiful
58+
[Kandy](https://kotlin.github.io/kandy/) visualizations.
59+
60+
* [Top-12 German Companies Financial Analyze](https://github.com/Kotlin/dataframe/blob/master/examples/notebooks/top_12_german_companies)
61+
— analyze key financial metrics for several major German companies.
62+
63+
* [Movies Example](https://github.com/Kotlin/dataframe/blob/master/examples/notebooks/movies/movies.ipynb)
64+
— basic Kotlin DataFrame operations on data from [movielens](https://movielens.org/).
65+
66+
* [YouTube Example](https://github.com/Kotlin/dataframe/blob/master/examples/notebooks/youtube/Youtube.ipynb)
67+
— explore YouTube videos with YouTube REST API and Kotlin Dataframe.
68+
69+
* [IMDb SQL Database Example](https://github.com/zaleslaw/KotlinDataFrame-SQL-Examples/blob/master/notebooks/imdb.ipynb)
70+
— analyze IMDb data stored in MariaDB using Kotlin DataFrame
71+
and visualize with [Kandy](https://kotlin.github.io/kandy/).
72+
73+
74+
See also [Kandy User Guides](https://kotlin.github.io/kandy/user-guide.html)
75+
and [Examples Gallery](https://kotlin.github.io/kandy/examples.html)
76+
for the best data visualizations using Kotlin DataFrame and Kandy together!

0 commit comments

Comments
 (0)