Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain the use-case for toDataFrame(columnName) in docs #837

Merged
merged 1 commit into from
Aug 27, 2024

Conversation

koperagen
Copy link
Collaborator

A step to instigate ideas about how api can be used

@koperagen koperagen added the documentation Improvements or additions to documentation (not KDocs) label Aug 23, 2024
@koperagen koperagen added this to the 0.14.0 milestone Aug 23, 2024
@koperagen koperagen requested a review from Jolanrensen August 23, 2024 15:11
@koperagen koperagen self-assigned this Aug 23, 2024
@@ -153,6 +153,12 @@ df.add("length") { value.length }

Creates a [`DataFrame`](DataFrame.md) from [`Iterable<T>`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/) with one column:
"columnName: `DataColumn<T>`".
An easy way to create a [`DataFrame`](DataFrame.md) when you have a list of File, URL or a structure
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...from an Iterable...

This is an easy way...

..list of Files, URLs, or any kind of structure you want...

In a notebook, ... see the number of rows...

..with the parts of the data you're...

It could be the File's content, a specific section of an HTML document, some metadata, etc.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oopsie. Thank you, fixed

Copy link
Collaborator

@Jolanrensen Jolanrensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spellcheck Jolan present :)

It's a good idea to include this in the new features notebook indeed. It's a nice use-case, unique to DF, to be able to store a File object inside a dataframe and work with it later! Good job :D

@koperagen koperagen force-pushed the toDataFrame-docs-update branch from 5c1bc71 to 2eb5c66 Compare August 26, 2024 13:43
@koperagen koperagen requested a review from Jolanrensen August 26, 2024 13:44
@koperagen koperagen force-pushed the toDataFrame-docs-update branch from 2eb5c66 to 767f20a Compare August 27, 2024 17:21
@koperagen koperagen merged commit c229232 into master Aug 27, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation (not KDocs)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants