Adding Plot ESS Evolution (#71)

* Initial ess evolution plot

updated plot_ess_evolution including a common ess_dataset computing func

added mean and sd annotations like essplot

docs and example gallery for plot_ess_evolution

updated verticalalign logic for mean/sd and correct (although overlaid and not flattened yet) rug is now displayed

removed rug plot

added tests

updated scatter_xy func to plot_ess version

fixed docstring

altered store_artist for xlabel, ylabel and modified hypothesis tests

shifted mean_ess, sd_edd computing to before plot_kwargs check+artist plotting logic

updated docstring, added figsizing and set vertical_align for mean and sd text kwargs as setdefault

removed 'rankdata' branch of arviz-stats from dependencies

docstring typo fix

gallery-generator updated for documentation building

* remove visual duplicated when rebasing

---------

Co-authored-by: Oriol (ProDesk) <[email protected]>

docs/source/api/plots.rst

@@ -20,7 +20,8 @@ A complementary introduction and guide to ``plot_...`` functions is available at
    plot_compare
    plot_dist
    plot_ess
+   plot_ess_evolution
    plot_forest
    plot_ridge
    plot_trace
-   plot_trace_dist
+   plot_trace_dist

docs/source/api/visuals.rst

@@ -15,6 +15,7 @@ Data plotting elements
    line_x
    scatter_xy
    scatter_x
+   scatter_xy
    ecdf_line
    hist
 

docs/source/gallery/inference_diagnostics/plot_ess_evolution.py

@@ -0,0 +1,21 @@
+"""
+# ESS Evolution plot
+
+Facetted plot with ESS 'bulk' and 'tail' for each variable
+
+---
+
+:::{seealso}
+API Documentation: {func}`~arviz_plots.plot_ess_evolution`
+:::
+"""
+
+from arviz_base import load_arviz_data
+
+import arviz_plots as azp
+
+azp.style.use("arviz-clean")
+
+data = load_arviz_data("centered_eight")
+pc = azp.plot_ess_evolution(data, backend="none")  # change to preferred backend
+pc.show()

docs/sphinxext/gallery_generator.py

@@ -100,7 +100,7 @@ def main(app):
 
     index_page = ["(example_gallery)=\n# Example gallery"]
     backreferences = defaultdict(list)
-    api_regex = re.compile(r"azp\.(plot_[a-z]+)\(")
+    api_regex = re.compile(r"azp\.(plot_[a-z_]+)\(")
 
     for folder, title in dir_title_map.items():
         category_dir = gallery_dir / folder

src/arviz_plots/plots/__init__.py

@@ -3,6 +3,7 @@
 from .compareplot import plot_compare
 from .distplot import plot_dist
 from .essplot import plot_ess
+from .evolutionplot import plot_ess_evolution
 from .forestplot import plot_forest
 from .ridgeplot import plot_ridge
 from .tracedistplot import plot_trace_dist
@@ -15,5 +16,6 @@
     "plot_trace",
     "plot_trace_dist",
     "plot_ess",
+    "plot_ess_evolution",
     "plot_ridge",
 ]