malariagen_data.ag3.Ag3.plot_diversity_stats

Ag3.plot_diversity_stats(df_stats: DataFrame, color: str | Mapping | None = None, bar_plot_height: int = 450, bar_width: int = 30, scatter_plot_height: int = 500, scatter_plot_width: int = 500, template: Literal['ggplot2', 'seaborn', 'simple_white', 'plotly', 'plotly_white', 'plotly_dark', 'presentation', 'xgridoff', 'ygridoff', 'gridon', 'none'] | None = 'plotly_white', color_discrete_sequence: List | None = None, color_discrete_map: Mapping | None = None, category_orders: List | Mapping | None = None, plot_kwargs: Mapping | None = None, show: bool = True, renderer: str | None = None) → Tuple[Figure, ...] | None

Plot diversity summary statistics for multiple cohorts.

Parameters

df_statsDataFrame

Output from diversity_stats().

colorstr or Mapping or None, optional

Name of variable to use to color the markers.

bar_plot_heightint, optional, default: 450

Height of bar plots in pixels (px).

bar_widthint, optional, default: 30

Width per bar in pixels (px).

scatter_plot_heightint, optional, default: 500

Height of scatter plot in pixels (px).

scatter_plot_widthint, optional, default: 500

Width of scatter plot in pixels (px).

template{‘ggplot2’, ‘seaborn’, ‘simple_white’, ‘plotly’, ‘plotly_white’, ‘plotly_dark’, ‘presentation’, ‘xgridoff’, ‘ygridoff’, ‘gridon’, ‘none’} or None, optional, default: ‘plotly_white’

The figure template name (must be a key in plotly.io.templates).

color_discrete_sequenceList or None, optional

Provide a list of colours to use.

color_discrete_mapMapping or None, optional

Provide an explicit mapping from values to colours.

category_ordersList or Mapping or None, optional

Control the order in which values appear in the legend.

plot_kwargsMapping or None, optional

Extra plotting parameters.

showbool, optional, default: True

If true, show the plot. If False, do not show the plot, but return the figure.

rendererstr or None, optional

The name of the renderer to use.

Returns

tuple of Figure or None