From af21823d513c6c01d9b8037fa6c2e68ab90fedfe Mon Sep 17 00:00:00 2001 From: hannah Date: Mon, 28 Oct 2024 18:49:26 -0400 Subject: [PATCH] Backport PR #27569: DOC: initial tags for statistics section of gallery --- galleries/examples/statistics/boxplot.py | 2 ++ galleries/examples/statistics/boxplot_color.py | 2 ++ galleries/examples/statistics/boxplot_demo.py | 2 ++ galleries/examples/statistics/boxplot_vs_violin.py | 2 ++ galleries/examples/statistics/bxp.py | 2 ++ galleries/examples/statistics/confidence_ellipse.py | 8 ++++++++ galleries/examples/statistics/customized_violin.py | 2 ++ galleries/examples/statistics/errorbar.py | 3 +++ galleries/examples/statistics/errorbar_features.py | 2 ++ galleries/examples/statistics/errorbar_limits.py | 2 ++ galleries/examples/statistics/errorbars_and_boxes.py | 8 ++++++++ galleries/examples/statistics/hexbin_demo.py | 2 ++ galleries/examples/statistics/hist.py | 9 +++++++++ galleries/examples/statistics/histogram_bihistogram.py | 4 ++++ galleries/examples/statistics/histogram_cumulative.py | 2 ++ galleries/examples/statistics/histogram_histtypes.py | 2 ++ galleries/examples/statistics/histogram_multihist.py | 2 ++ galleries/examples/statistics/histogram_normalization.py | 2 ++ .../statistics/multiple_histograms_side_by_side.py | 7 +++++++ galleries/examples/statistics/time_series_histogram.py | 8 ++++++++ galleries/examples/statistics/violinplot.py | 2 ++ 21 files changed, 75 insertions(+) diff --git a/galleries/examples/statistics/boxplot.py b/galleries/examples/statistics/boxplot.py index ccdaab97d24a..6d30cbd4b5f0 100644 --- a/galleries/examples/statistics/boxplot.py +++ b/galleries/examples/statistics/boxplot.py @@ -97,6 +97,8 @@ # %% # +# .. tags:: plot-type: boxplot, domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/boxplot_color.py b/galleries/examples/statistics/boxplot_color.py index 3491253aaf3e..acdb37d7d520 100644 --- a/galleries/examples/statistics/boxplot_color.py +++ b/galleries/examples/statistics/boxplot_color.py @@ -36,6 +36,8 @@ # %% # +# .. tags:: styling: color, domain: statistics, plot-type: boxplot +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/boxplot_demo.py b/galleries/examples/statistics/boxplot_demo.py index eca0e152078e..ec23408c0bfc 100644 --- a/galleries/examples/statistics/boxplot_demo.py +++ b/galleries/examples/statistics/boxplot_demo.py @@ -247,6 +247,8 @@ def fake_bootstrapper(n): # %% # +# .. tags:: domain: statistics, plot-type: boxplot +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/boxplot_vs_violin.py b/galleries/examples/statistics/boxplot_vs_violin.py index dce8912013b0..f277e737e65c 100644 --- a/galleries/examples/statistics/boxplot_vs_violin.py +++ b/galleries/examples/statistics/boxplot_vs_violin.py @@ -54,6 +54,8 @@ # %% # +# .. tags:: plot-type: violin, plot-type: boxplot, domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/bxp.py b/galleries/examples/statistics/bxp.py index b12bfebd16cc..3ddd164df742 100644 --- a/galleries/examples/statistics/bxp.py +++ b/galleries/examples/statistics/bxp.py @@ -64,6 +64,8 @@ # %% # +# .. tags:: plot-type: speciality, domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/confidence_ellipse.py b/galleries/examples/statistics/confidence_ellipse.py index 27b06146a44e..4ac0917f4bda 100644 --- a/galleries/examples/statistics/confidence_ellipse.py +++ b/galleries/examples/statistics/confidence_ellipse.py @@ -217,6 +217,14 @@ def get_correlated_dataset(n, dependency, mu, scale): # %% # +# .. tags:: +# +# plot-type: speciality +# plot-type: scatter +# component: ellipse +# component: patch +# domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/customized_violin.py b/galleries/examples/statistics/customized_violin.py index c1d2e432ca2e..29ddcda92fbe 100644 --- a/galleries/examples/statistics/customized_violin.py +++ b/galleries/examples/statistics/customized_violin.py @@ -73,6 +73,8 @@ def set_axis_style(ax, labels): # %% # +# .. tags:: plot-type: violin, domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/errorbar.py b/galleries/examples/statistics/errorbar.py index a25cadf88211..019590dc3f32 100644 --- a/galleries/examples/statistics/errorbar.py +++ b/galleries/examples/statistics/errorbar.py @@ -21,6 +21,9 @@ # %% # +# +# .. tags:: plot-type: errorbar, domain: statistics, +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/errorbar_features.py b/galleries/examples/statistics/errorbar_features.py index 349cc89ff2e0..8abaffcda537 100644 --- a/galleries/examples/statistics/errorbar_features.py +++ b/galleries/examples/statistics/errorbar_features.py @@ -48,6 +48,8 @@ # %% # +# .. tags:: plot-type: errorbar, domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/errorbar_limits.py b/galleries/examples/statistics/errorbar_limits.py index d5b0e476d894..f1d26460d947 100644 --- a/galleries/examples/statistics/errorbar_limits.py +++ b/galleries/examples/statistics/errorbar_limits.py @@ -77,6 +77,8 @@ # %% # +# .. tags:: plot-type: errorbar, domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/errorbars_and_boxes.py b/galleries/examples/statistics/errorbars_and_boxes.py index 54c8786096c7..b45eee751137 100644 --- a/galleries/examples/statistics/errorbars_and_boxes.py +++ b/galleries/examples/statistics/errorbars_and_boxes.py @@ -71,6 +71,14 @@ def make_error_boxes(ax, xdata, ydata, xerror, yerror, facecolor='r', # %% # +# +# .. tags:: +# +# plot-type: errorbar +# component: rectangle +# component: patchcollection +# domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/hexbin_demo.py b/galleries/examples/statistics/hexbin_demo.py index b9a6206a934f..bd1522772aae 100644 --- a/galleries/examples/statistics/hexbin_demo.py +++ b/galleries/examples/statistics/hexbin_demo.py @@ -35,6 +35,8 @@ # %% # +# .. tags:: plot-type: histogram, plot-type: hexbin, domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/hist.py b/galleries/examples/statistics/hist.py index 8b06093913df..e31aca0228c2 100644 --- a/galleries/examples/statistics/hist.py +++ b/galleries/examples/statistics/hist.py @@ -103,6 +103,15 @@ # %% # +# .. tags:: +# +# plot-type: histogram, +# plot-type: histogram2d +# domain: statistics +# styling: color, +# component: normalization +# component: patch +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/histogram_bihistogram.py b/galleries/examples/statistics/histogram_bihistogram.py index 7bfae14e9285..73f549493438 100644 --- a/galleries/examples/statistics/histogram_bihistogram.py +++ b/galleries/examples/statistics/histogram_bihistogram.py @@ -43,3 +43,7 @@ ax.legend() plt.show() + +# %% +# +# .. tags:: plot-type: histogram, domain: statistics, purpose: showcase diff --git a/galleries/examples/statistics/histogram_cumulative.py b/galleries/examples/statistics/histogram_cumulative.py index 9ce16568d126..d87305629f8d 100644 --- a/galleries/examples/statistics/histogram_cumulative.py +++ b/galleries/examples/statistics/histogram_cumulative.py @@ -67,6 +67,8 @@ # %% # +# .. tags:: plot-type: ecdf, plot-type: histogram, domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/histogram_histtypes.py b/galleries/examples/statistics/histogram_histtypes.py index 0188d7bf5d0f..53d6425cf4dc 100644 --- a/galleries/examples/statistics/histogram_histtypes.py +++ b/galleries/examples/statistics/histogram_histtypes.py @@ -51,6 +51,8 @@ # %% # +# .. tags:: plot-type: histogram, domain: statistics, purpose: reference +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/histogram_multihist.py b/galleries/examples/statistics/histogram_multihist.py index f1957dc38939..78ff03719057 100644 --- a/galleries/examples/statistics/histogram_multihist.py +++ b/galleries/examples/statistics/histogram_multihist.py @@ -47,6 +47,8 @@ # %% # +# .. tags:: plot-type: histogram, domain: statistics, purpose: reference +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/histogram_normalization.py b/galleries/examples/statistics/histogram_normalization.py index 9418b7af002b..2c423edad208 100644 --- a/galleries/examples/statistics/histogram_normalization.py +++ b/galleries/examples/statistics/histogram_normalization.py @@ -243,6 +243,8 @@ # %% # +# .. tags:: plot-type: histogram, domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/multiple_histograms_side_by_side.py b/galleries/examples/statistics/multiple_histograms_side_by_side.py index 3c5766f8e546..733aed51f253 100644 --- a/galleries/examples/statistics/multiple_histograms_side_by_side.py +++ b/galleries/examples/statistics/multiple_histograms_side_by_side.py @@ -63,6 +63,13 @@ # %% # +# .. tags:: +# +# domain: statistics +# plot-type: barh +# plot-type: histogram +# styling: position +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/time_series_histogram.py b/galleries/examples/statistics/time_series_histogram.py index 371d182915b8..6f9a543fb4e5 100644 --- a/galleries/examples/statistics/time_series_histogram.py +++ b/galleries/examples/statistics/time_series_histogram.py @@ -94,6 +94,14 @@ # %% # +# .. tags:: +# +# plot-type: histogram2d +# plot-type: pcolormesh +# purpose: storytelling +# styling: color +# component: colormap +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown diff --git a/galleries/examples/statistics/violinplot.py b/galleries/examples/statistics/violinplot.py index afcc1c977034..3d0d44538032 100644 --- a/galleries/examples/statistics/violinplot.py +++ b/galleries/examples/statistics/violinplot.py @@ -106,6 +106,8 @@ # %% # +# .. tags:: plot-type: violin, domain: statistics +# # .. admonition:: References # # The use of the following functions, methods, classes and modules is shown