markdown_utils#

Attributes#

`chart_types_md`
`example_intents_md`

Functions#

`create_error_markdown`(→ str)
`create_project_markdown`(→ str)
`escape_markdown`(→ str)	Escape special markdown characters.
`create_column_markdown`(→ str)
`create_suggested_questions_prompt`(→ str)

Module Contents#

markdown_utils.create_error_markdown(message: str, traceback: str | None = None, extra_metadata: dict | None = None) → str[source]#

markdown_utils.create_project_markdown(project: mdvtools.mdvproject.MDVProject) → str[source]#

markdown_utils.escape_markdown(text: str) → str[source]#: Escape special markdown characters. In future we may want more advanced markdown functionality which may warrant adding a markdown library.

markdown_utils.create_column_markdown(cols: list[dict]) → str[source]#

markdown_utils.chart_types_md = Multiline-String[source]#

Show Value

"""
- Abundance Box Plot
- Box Plot
- Density Scatter Plot
- Dot Plot
- Heat Map
- Histogram Plot
- Multi Line Chart
- Pie Chart
- Row Chart
- Row Summary Box
- Sankey Diagram
- Stacked Row Chart (Categorical Heatmap)
- Table
- Text Box
- 2D Scatter Plot
- Violin Plot
- Word Cloud
"""

markdown_utils.example_intents_md = Multiline-String[source]#

Show Value

"""
- "distribution", "spread" = Histogram Plot, Box Plot, Violin Plot
- "relationship", "correlation" = Scatter Plot, Density Scatter, Heat Map
- "comparison", "difference", "change" = Box Plot, Violin Plot, Multi Line Chart, Dot Plot
- "composition", "proportion", "breakdown" = Pie Chart, Stacked Row Chart, Row Chart
- "over time", "trend", "temporal" = Line Chart, Multi Line Chart
- "expression", "gene", "marker" = Dot Plot, Heat Map, Box Plot
- "spatial", "location", "embedding" = 2D Scatter Plot, Density Scatter Plot
- "flow", "transition" = Sankey Diagram
- "metadata", "category", "annotation" = Table, Row Summary Box, Row Chart
- "filter", "subset", "select" = Selection Dialog Plot
"""

markdown_utils.create_suggested_questions_prompt(project: mdvtools.mdvproject.MDVProject) → str[source]#