core

:core

This is the core of the library, published as the dataframe-core package. It contains the DataFrame API and its implementation, as well as plenty of JUnit tests.

I/O operations are split off into other modules, like :dataframe-excel, :dataframe-jdbc, or :dataframe-json.

See the documentation website for how this API is meant to be used, and Operations for the reference of everything in it.

At the moment, these integrations are still part of the :core module:

• (deprecated) csv/tsv
• html

KoDEx

The code you're working on needs to be edited in src, but the KDocs are processed by KoDEx when the project is published (or the task is run manually). The generated sources with adjusted KDocs will be overwritten in generated-sources. See the KDoc Preprocessing Guide for more information.

KDocs can also be exported to HTML, for them to be reused on the website. Elements annotated with @ExportAsHtml will have their generated content copied over to docs/StardustDocs/resources/snippets/kdocs.

Korro (NOTE: This is being moved to :samples)

Should be removed and moved to :samples module.

Tests in this module contain code samples used for import into documentation using Korro.

Explainer dataframes (NOTE: This is being moved to :samples)

Should be removed and migrated to SampleHelper.

Aside from code samples, @TransformDataFrameExpressions annotated test functions also generate sample dataframe HTML files that can be used as iFrames on the documentation website. They are tested, generated, and copied over to docs/StardustDocs/resources/snippets by our "explainer" plugin callback proxy, which hooks into the TestBase class and retrieves the intermediate DataFrame expressions thanks to our "explainer" compiler plugin :plugins:expressions-converter.