Skip to content

Commit dcd77dc

Browse files
authored
Converted all the data type mentions to the links on the mentioned types (#273)
* Added uncompiled version * Set up the Java 11 for sources of this example due to the lowest JDK 11 in KotlinDL * Fixed the DataFrame links * Fixed the DataRow * Fixed the other * Fixed the other
1 parent 913ac8d commit dcd77dc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+272
-252
lines changed

docs/StardustDocs/topics/ColumnSelectors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Access-->
44

5-
`DataFrame` provides DSL for selecting arbitrary set of columns.
5+
[`DataFrame`](DataFrame.md) provides DSL for selecting arbitrary set of columns.
66

77
Column selectors are used in many operations:
88

docs/StardustDocs/topics/DataColumn.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[//]: # (title: DataColumn)
22
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Create-->
33

4-
`DataColumn` represents a column of values. It can store objects of primitive or reference types, or other [`DataFrames`](DataFrame.md).
4+
[`DataColumn`](DataColumn.md) represents a column of values. It can store objects of primitive or reference types, or other [`DataFrames`](DataFrame.md).
55

66
See [how to create columns](createColumn.md)
77

@@ -14,7 +14,7 @@ See [how to create columns](createColumn.md)
1414
* `size: Int` — number of elements in the column
1515

1616
### Column kinds
17-
`DataColumn` instances can be one of three subtypes: `ValueColumn`, `ColumnGroup` or `FrameColumn`
17+
[`DataColumn`](DataColumn.md) instances can be one of three subtypes: `ValueColumn`, [`ColumnGroup`](DataColumn.md#columngroup) or [`FrameColumn`](DataColumn.md#framecolumn)
1818

1919
#### ValueColumn
2020

@@ -30,13 +30,13 @@ Container for nested columns. Is used to create column hierarchy.
3030

3131
Special case of [`ValueColumn`](#valuecolumn) that stores other [`DataFrames`](DataFrame.md) as elements.
3232

33-
`DataFrames` stored in `FrameColumn` may have different schemas.
33+
[`DataFrames`](DataFrame.md) stored in [`FrameColumn`](DataColumn.md#framecolumn) may have different schemas.
3434

35-
`FrameColumn` may appear after [reading](read.md) from JSON or other hierarchical data structures, or after grouping operations such as [groupBy](groupBy.md) or [pivot](pivot.md).
35+
[`FrameColumn`](DataColumn.md#framecolumn) may appear after [reading](read.md) from JSON or other hierarchical data structures, or after grouping operations such as [groupBy](groupBy.md) or [pivot](pivot.md).
3636

3737
## Column accessors
3838

39-
`ColumnAccessors` are used for [typed data access](columnAccessorsApi.md) in `DataFrame`. `ColumnAccessor` stores column [`name`](#properties) (for top-level columns) or column path (for nested columns), has type argument that corresponds to [`type`](#properties) of thep column, but it doesn't contain any actual data.
39+
`ColumnAccessors` are used for [typed data access](columnAccessorsApi.md) in [`DataFrame`](DataFrame.md). `ColumnAccessor` stores column [`name`](#properties) (for top-level columns) or column path (for nested columns), has type argument that corresponds to [`type`](#properties) of thep column, but it doesn't contain any actual data.
4040

4141
<!---FUN columnAccessorsUsage-->
4242

docs/StardustDocs/topics/DataFrame.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[//]: # (title: DataFrame)
22

3-
`DataFrame` represents a list of [`DataColumn`](DataColumn.md).
3+
[`DataFrame`](DataFrame.md) represents a list of [`DataColumn`](DataColumn.md).
44

55
Columns in dataframe must have equal size and unique names.
66

docs/StardustDocs/topics/DataRow.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
## Row functions
77

8-
* `index(): Int` — sequential row number in `DataFrame`, starts from 0
8+
* `index(): Int` — sequential row number in [`DataFrame`](DataFrame.md), starts from 0
99
* `prev(): DataRow?` — previous row (`null` for the first row)
1010
* `next(): DataRow?` — next row (`null` for the last row)
1111
* `diff { rowExpression }: T` — difference between results of [row expression](#row-expressions) calculated for current and previous rows
@@ -18,14 +18,14 @@
1818
* `namedValuesOf<T>(): List<NameValuePair<T>>` — list of name-value pairs where value has given type
1919
* `transpose(): DataFrame<NameValuePair<*>>` — dataframe of two columns: `name: String` is column names and `value: Any?` is cell values
2020
* `transposeTo<T>(): DataFrame<NameValuePair<T>>`— dataframe of two columns: `name: String` is column names and `value: T` is cell values
21-
* `getRow(Int): DataRow` — row from `DataFrame` by row index
21+
* `getRow(Int): DataRow` — row from [`DataFrame`](DataFrame.md) by row index
2222
* `getRows(Iterable<Int>): DataFrame` — dataframe with subset of rows selected by absolute row index.
2323
* `relative(Iterable<Int>): DataFrame` — dataframe with subset of rows selected by relative row index: `relative(-1..1)` will return previous, current and next row. Requested indices will be coerced to the valid range and invalid indices will be skipped
2424
* `get(column): T` — cell value by this row and given `column`
25-
* `df()``DataFrame` that current row belongs to
25+
* `df()`[`DataFrame`](DataFrame.md) that current row belongs to
2626

2727
## Row expressions
28-
Row expressions provide a value for every row of `DataFrame` and are used in [add](add.md), [filter](filter.md), [forEach](iterate.md), [update](update.md) and other operations.
28+
Row expressions provide a value for every row of [`DataFrame`](DataFrame.md) and are used in [add](add.md), [filter](filter.md), [forEach](iterate.md), [update](update.md) and other operations.
2929

3030
<!---FUN expressions-->
3131

@@ -75,7 +75,7 @@ The following [statistics](summaryStatistics.md) are available for `DataRow`:
7575
* `rowMedian`
7676

7777
These statistics will be applied only to values of appropriate types and incompatible values will be ignored.
78-
For example, if `DataFrame` has columns of type `String` and `Int`, `rowSum()` will successfully compute sum of `Int` values in a row and ignore `String` values.
78+
For example, if [`DataFrame`](DataFrame.md) has columns of type `String` and `Int`, `rowSum()` will successfully compute sum of `Int` values in a row and ignore `String` values.
7979

8080
To apply statistics only to values of particular type use `-Of` versions:
8181
* `rowMaxOf<T>`

docs/StardustDocs/topics/KPropertiesApi.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.ApiLevels-->
44

5-
`Kotlin Dataframe` can be used as an intermediate structure for data transformation between two data formats. If either source or destination is a Kotlin object, e.g. data class, it is convenient to use its properties for typed data access in `DataFrame`.
5+
[`DataFrame`](DataFrame.md) can be used as an intermediate structure for data transformation between two data formats.
6+
If either source or destination is a Kotlin object, e.g. data class, it is convenient to use its properties for typed data access in [`DataFrame`](DataFrame.md).
67
This can be done using `::` expression that provides [property references](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property/)
78

89
<!---FUN kproperties1-->
@@ -28,7 +29,7 @@ val passengers = DataFrame.read("titanic.csv")
2829

2930
<!---END-->
3031

31-
By default, `DataFrame` uses `name` and `returnType` of `KProperty` for typed access to data. When column name differs from property name, use `ColumnName` annotation:
32+
By default, [`DataFrame`](DataFrame.md) uses `name` and `returnType` of `KProperty` for typed access to data. When column name differs from property name, use `ColumnName` annotation:
3233

3334
<!---FUN kproperties2-->
3435

docs/StardustDocs/topics/add.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Modify-->
44

5-
Returns `DataFrame` which contains all columns from original `DataFrame` followed by newly added columns. Original `DataFrame` is not modified.
5+
Returns [`DataFrame`](DataFrame.md) which contains all columns from original [`DataFrame`](DataFrame.md) followed by newly added columns.
6+
Original [`DataFrame`](DataFrame.md) is not modified.
67

7-
## Create new column and add it to `DataFrame`
8+
## Create new column and add it to [`DataFrame`](DataFrame.md)
89

910
```text
1011
add(columnName: String) { rowExpression }
@@ -55,7 +56,7 @@ df.add("fibonacci") {
5556

5657
<!---END-->
5758

58-
## Create and add several columns to `DataFrame`
59+
## Create and add several columns to [`DataFrame`](DataFrame.md)
5960

6061
```kotlin
6162
add {
@@ -191,7 +192,7 @@ val personWithCityInfo = df.add {
191192
</tab></tabs>
192193
<!---END-->
193194

194-
## Add existing column to `DataFrame`
195+
## Add existing column to [`DataFrame`](DataFrame.md)
195196

196197
<!---FUN addExisting-->
197198

@@ -204,7 +205,7 @@ df + score
204205

205206
<!---END-->
206207

207-
## Add all columns from another `DataFrame`
208+
## Add all columns from another [`DataFrame`](DataFrame.md)
208209

209210
<!---FUN addDfs-->
210211

@@ -216,7 +217,7 @@ df.add(df1, df2)
216217

217218
## addId
218219

219-
Adds column with sequential values 0, 1, 2,... New column will be added in the beginning of columns list and will become the first column in `DataFrame`.
220+
Adds column with sequential values 0, 1, 2,... New column will be added in the beginning of columns list and will become the first column in [`DataFrame`](DataFrame.md).
220221

221222
```
222223
addId(name: String = "id")

docs/StardustDocs/topics/addDf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Modify-->
44

5-
Returns `DataFrame` with union of columns from several given `DataFrames`.
5+
Returns [`DataFrame`](DataFrame.md) with union of columns from several given [`DataFrames`](DataFrame.md).
66

77
<!---FUN addDfs-->
88

docs/StardustDocs/topics/addRemove.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[//]: # (title: Add/map/remove columns)
22

3-
* [`add`](add.md) columns to `DataFrame`
4-
* [`map`](map.md) columns to new `DataFrame` or `DataColumn`
5-
* [`remove`](remove.md) columns from `DataFrame`
3+
* [`add`](add.md) columns to [`DataFrame`](DataFrame.md)
4+
* [`map`](map.md) columns to new [`DataFrame`](DataFrame.md) or [`DataColumn`](DataColumn.md)
5+
* [`remove`](remove.md) columns from [`DataFrame`](DataFrame.md)
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[//]: # (title: Adjust schema)
22

3-
`DataFrame` interface has type argument `T` that doesn't affect contents of `DataFrame`, but marks `DataFrame` with a type that represents data schema that this `DataFrame` is supposed to have.
3+
[`DataFrame`](DataFrame.md) interface has type argument `T` that doesn't affect contents of `DataFrame`, but marks `DataFrame` with a type that represents data schema that this `DataFrame` is supposed to have.
44
This argument is used to generate [extension properties](extensionPropertiesApi.md) for typed data access.
55

6-
Actual data in `DataFrame` may diverge from compile-time schema marker `T` due to dynamic nature of data inside `DataFrame`. However, at some points of code you may know exactly what `DataFrame` schema is expected.
7-
To match your knowledge with expected real-time `DataFrame` contents you can use one of two functions:
8-
* [`cast`](cast.md) — change type argument of `DataFrame` to the expected schema without changing data in `DataFrame`.
9-
* [`convertTo`](convertTo.md) — convert `DataFrame` contents to match the expected schema.
6+
Actual data in [`DataFrame`](DataFrame.md) may diverge from compile-time schema marker `T` due to dynamic nature of data inside `DataFrame`. However, at some points of code you may know exactly what `DataFrame` schema is expected.
7+
To match your knowledge with expected real-time [`DataFrame`](DataFrame.md) contents you can use one of two functions:
8+
* [`cast`](cast.md) — change type argument of [`DataFrame`](DataFrame.md) to the expected schema without changing data in `DataFrame`.
9+
* [`convertTo`](convertTo.md) — convert [`DataFrame`](DataFrame.md) contents to match the expected schema.
1010

docs/StardustDocs/topics/apiLevels.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ By nature data frames are dynamic objects, column labels depend on the input sou
66
or deleted while wrangling. Kotlin, in contrast, is a statically typed language and all types are defined and verified
77
ahead of execution. That's why creating a flexible, handy, and, at the same time, safe API to a data frame is tricky.
88

9-
In `Kotlin DataFrame` we provide four different ways to access columns, and, while they are essentially different, they
9+
In Kotlin DataFrame library we provide four different ways to access columns, and, while they are essentially different, they
1010
look pretty similar in the data wrangling DSL.
1111

1212
## List of Access APIs
@@ -147,10 +147,10 @@ Currently, we are working on compiler a plugin that generates these properties o
147147

148148
The [Column Accessors API](columnAccessorsApi.md) is a kind of trade-off between safety and needs to be written ahead of
149149
the execution type declaration. It was designed to better be able to write code in an IDE without a notebook experience.
150-
It provides type-safe access to columns but doesn't ensure that the columns really exist in a particular dataframe.
150+
It provides type-safe access to columns but doesn't ensure that the columns really exist in a particular [`DataFrame`](DataFrame.md).
151151

152152
The [KProperties API](KPropertiesApi.md) is useful when you already have declared classed in your application business
153-
logic with fields that correspond columns of dataframe.
153+
logic with fields that correspond columns of [`DataFrame`](DataFrame.md).
154154

155155
<table>
156156
<tr>

0 commit comments

Comments
 (0)