docs: initial rough draft of dx docs with templates #487
Conversation
dsmmcken
changed the title
dsmmcken
changed the title
|
@jnumainville I am probably missing some types for rough-in too. I have the images, but not the .md files for all current types. |
|
|
||
| ```python order=scatter_plot_diamonds,scatter_plot_symbol_by,scatter_plot_symbol_map | ||
| import deephaven.plot.express as dx | ||
| my_table = dx.data.iris() # import the example iris data set |
There was a problem hiding this comment.
Random thought I happened to have here - I know the datasets are very much tied to the examples we are making, but it could be worth having a separate page that explains a bit more about the data sets.
| title: Timelint Plot | ||
| --- | ||
|
|
||
| Timeline plots in offer a means to visualize time-related data, displaying events, durations, or activities along a time axis. Developers can utilize these plots for applications that require users to understand temporal patterns and relationships, such as project management, event scheduling, and historical data analysis. |
There was a problem hiding this comment.
Worth pointing out that this is also known as a Gantt plot
| title: Treemap Plot | ||
| --- | ||
|
|
||
| Treemap plots are a data visualization technique used to represent hierarchical data in a space-filling manner. They display data as nested rectangles or squares, where the size and color of each rectangle represent the values or categories within the hierarchy. Developers can create treemaps to provide users with an efficient and visually intuitive way to explore hierarchical data structures and understand relationships between categories and subcategories, making them a valuable tool for various applications that involve hierarchical data presentation, analysis, and exploration. |
There was a problem hiding this comment.
Treemap, sunbursts, and icicles are more or less identical - worth linking?
| title: Violin Plot | ||
| --- | ||
|
|
||
| A violin plot is a data visualization that combines a box plot with a rotated kernel density plot to provide a comprehensive representation of the data distribution. It offers a detailed view of the data's central tendency, spread and density. |
There was a problem hiding this comment.
Hmm, for some of these plot groups where they are so similar (strip vs box vs violin or treemap vs icicle vs sunburst for example) it might be worth having a direct comparison page, maybe with a table or something. Doesn't have to be done now but could be worth it because some of the nuances with these are so subtle.
|
|
||
| ### Basic Plots | ||
|
|
||
| [](scatter.md) |
There was a problem hiding this comment.
We should probably have the name visible underneath as well, so that you can Find it in the doc easily.
There was a problem hiding this comment.
Yeah, I need to lookup how to add a caption using GFM.
|
|
||
| We should have a seperate section covering shared concepts such as: | ||
|
|
||
| - Plot by |
There was a problem hiding this comment.
plotBy / plot_by? or explain what "plot by" means
|
|
||
| <!-- Update number if count changes --> | ||
|
|
||
| This page contains a collection of links to examples demonstrating 24 different plot types and usage scenarios. You can explore these examples to gain a better understanding of how to leverage the library in your projects. |
There was a problem hiding this comment.
do we need a specific number?
There was a problem hiding this comment.
no, and could remove.
|
|
||
| Candlestick plots are a financial data visualization tool commonly used in technical analysis. Similar to an OHLC, they also represent the open, close, high, and low prices of a financial instrument for a specific time period, providing insights into price movements and patterns, and aiding in the identification of trends and potential reversal points in financial markets. | ||
|
|
||
| Interpreting a candlestick chart involves understanding the visual representation of price data within a specific time frame. Each candlestick consists of a rectangular "body" representing the price range between the opening and closing prices, with the "wick" or "shadow" lines extending above and below the body indicating the high and low prices during that time period. |
There was a problem hiding this comment.
chart or plot? maybe stick to plot
There was a problem hiding this comment.
plot would be preferred wording for consistency.
Co-authored-by: Joe <josephnumainville@deephaven.io> Co-authored-by: margaretkennedy <82049573+margaretkennedy@users.noreply.github.com>
|
Joe's suggestions are good and should be address in follow up PRs if we want to merge this now, and let Alex keep grinding. |
Noted. If we could do without resolving these comments so that I can navigate the feedback as I work through, that would be good. |
I've roughed out each file, scatter.md is the only one though that is roughly complete
To-do create relevant examples for everything. Which may require additional example data sets.