Add image examples to plots

src/crested/pl/_contribution_scores.py

@@ -73,6 +73,8 @@ def contribution_scores(
     >>> seqs_one_hot = np.random.randint(0, 2, (1, 100, 4))
     >>> class_names = ["class1"]
     >>> crested.pl.contribution_scores(scores, seqs_one_hot, class_names)
+
+    .. image:: ../../../docs/_static/img/examples/contribution_scores.png
     """
     # Center and zoom
     _check_contrib_params(zoom_n_bases, scores)

src/crested/pl/bar/_normalization_weights.py

@@ -36,6 +36,8 @@ def normalization_weights(adata: AnnData, **kwargs):
     ...     height=3,
     ...     title="Normalization scaling factors",
     ... )
+
+    .. image:: ../../../docs/_static/img/examples/bar_normalization_weights.png
     """
 
     @log_and_raise(ValueError)

src/crested/pl/bar/_region.py

@@ -44,10 +44,13 @@ def region_predictions(
     -------
     >>> crested.pl.bar.region_predictions(
     ...     adata,
-    ...     region="chr1:10000-10500",
-    ...     model_names=["model1", "model2"],
+    ...     region='chr1:3094805-3095305'
+    ...     model_names=["model_1", "model_2"],
     ...     share_y=False,
+    ...     title="Region chr1:3094805-3095305"
     ... )
+
+    .. image:: ../../../docs/_static/img/examples/bar_region_predictions.png
     """
 
     @log_and_raise(ValueError)
@@ -133,13 +136,15 @@ def region(adata: AnnData, region: str, target: str = "groundtruth", **kwargs) -
     -------
     >>> crested.pl.bar.region(
     ...     adata,
-    ...     region="chr1:10000-10500",
+    ...     region="chr1:3094805-3095305",
     ...     target="groundtruth",
     ...     xlabel="Cell Type",
     ...     ylabel="Peak height",
     ...     figsize=(20, 3),
-    ...     figtitle="Peak Heights",
+    ...     figtitle="chr1:3094805-3095305",
     ... )
+
+    .. image:: ../../../docs/_static/img/examples/bar_region.png
     """
 
     @log_and_raise(ValueError)

src/crested/pl/heatmap/_correlations.py

@@ -62,9 +62,10 @@ def correlations_self(
     Examples
     --------
     >>> crested.pl.heatmap.correlations_self(
-    ...     adata, log_transform=True, title="Self Correlations"
+    ...     adata, log_transform=True, title="Self correlations heatmap"
     ... )
 
+    .. image:: ../../../docs/_static/img/examples/heatmap_self_correlations.png
     """
     x = adata.X
     classes = list(adata.obs_names)
@@ -126,8 +127,12 @@ def correlations_predictions(
     ...     model_names=None,
     ...     split="test",
     ...     log_transform=True,
+    ...     vmin=0.4,
+    ...     vmax=0.85,
     ...     title="Correlations: Predictions vs Ground Truth",
     ... )
+
+    .. image:: ../../../docs/_static/img/examples/heatmap_correlations_predictions.png
     """
 
     @log_and_raise(ValueError)

src/crested/pl/hist/_distribution.py

@@ -50,6 +50,8 @@ def distribution(
     >>> crested.pl.hist.distribution(
     ...     adata, split="test", share_y=False, class_names=["Astro", "Vip"]
     ... )
+
+    .. image:: ../../../docs/_static/img/examples/hist_distribution.png
     """
 
     @log_and_raise(ValueError)

src/crested/pl/scatter/_class_density.py

@@ -53,11 +53,14 @@ def class_density(
     Example
     -------
     >>> crested.pl.scatter.class_density(
+    ...     adata,
     ...     class_name="Astro",
     ...     model_names=["model1", "model2"],
     ...     split="test",
     ...     log_transform=True,
     ... )
+
+    .. image:: ../../../docs/_static/img/examples/scatter_class_density.png
     """
 
     @log_and_raise(ValueError)