Merge pull request #29033 from meeseeksmachine/auto-backport-of-pr-27569-on-v3.9.2-doc

greglucas · web-flow · commit 78595205f88d · 2024-10-29T14:57:23.000-06:00
Backport PR #27569 on branch v3.9.2-doc (DOC: initial tags for statistics section of gallery)
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -106,6 +106,8 @@
 
 # %%
 #
+# .. tags:: plot-type: violin, domain: statistics
+#
 # .. admonition:: References
 #
 #    The use of the following functions, methods, classes and modules is shown

Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,8 @@`
`97`	`97`
`98`	`98`	`# %%`
`99`	`99`	`#`
	`100`	`+# .. tags:: plot-type: boxplot, domain: statistics`
	`101`	`+#`
`100`	`102`	`# .. admonition:: References`
`101`	`103`	`#`
`102`	`104`	`# The use of the following functions, methods, classes and modules is shown`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,8 @@`
`36`	`36`
`37`	`37`	`# %%`
`38`	`38`	`#`
	`39`	`+# .. tags:: styling: color, domain: statistics, plot-type: boxplot`
	`40`	`+#`
`39`	`41`	`# .. admonition:: References`
`40`	`42`	`#`
`41`	`43`	`# The use of the following functions, methods, classes and modules is shown`
Original file line number	Diff line number	Diff line change
`@@ -247,6 +247,8 @@ def fake_bootstrapper(n):`
`247`	`247`
`248`	`248`	`# %%`
`249`	`249`	`#`
	`250`	`+# .. tags:: domain: statistics, plot-type: boxplot`
	`251`	`+#`
`250`	`252`	`# .. admonition:: References`
`251`	`253`	`#`
`252`	`254`	`# The use of the following functions, methods, classes and modules is shown`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,8 @@`
`54`	`54`
`55`	`55`	`# %%`
`56`	`56`	`#`
	`57`	`+# .. tags:: plot-type: violin, plot-type: boxplot, domain: statistics`
	`58`	`+#`
`57`	`59`	`# .. admonition:: References`
`58`	`60`	`#`
`59`	`61`	`# The use of the following functions, methods, classes and modules is shown`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,8 @@`
`64`	`64`
`65`	`65`	`# %%`
`66`	`66`	`#`
	`67`	`+# .. tags:: plot-type: speciality, domain: statistics`
	`68`	`+#`
`67`	`69`	`# .. admonition:: References`
`68`	`70`	`#`
`69`	`71`	`# The use of the following functions, methods, classes and modules is shown`
Original file line number	Diff line number	Diff line change
`@@ -217,6 +217,14 @@ def get_correlated_dataset(n, dependency, mu, scale):`
`217`	`217`
`218`	`218`	`# %%`
`219`	`219`	`#`
	`220`	`+# .. tags::`
	`221`	`+#`
	`222`	`+# plot-type: speciality`
	`223`	`+# plot-type: scatter`
	`224`	`+# component: ellipse`
	`225`	`+# component: patch`
	`226`	`+# domain: statistics`
	`227`	`+#`
`220`	`228`	`# .. admonition:: References`
`221`	`229`	`#`
`222`	`230`	`# The use of the following functions, methods, classes and modules is shown`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,8 @@ def set_axis_style(ax, labels):`
`73`	`73`
`74`	`74`	`# %%`
`75`	`75`	`#`
	`76`	`+# .. tags:: plot-type: violin, domain: statistics`
	`77`	`+#`
`76`	`78`	`# .. admonition:: References`
`77`	`79`	`#`
`78`	`80`	`# The use of the following functions, methods, classes and modules is shown`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,9 @@`
`21`	`21`
`22`	`22`	`# %%`
`23`	`23`	`#`
	`24`	`+#`
	`25`	`+# .. tags:: plot-type: errorbar, domain: statistics,`
	`26`	`+#`
`24`	`27`	`# .. admonition:: References`
`25`	`28`	`#`
`26`	`29`	`# The use of the following functions, methods, classes and modules is shown`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,8 @@`
`48`	`48`
`49`	`49`	`# %%`
`50`	`50`	`#`
	`51`	`+# .. tags:: plot-type: errorbar, domain: statistics`
	`52`	`+#`
`51`	`53`	`# .. admonition:: References`
`52`	`54`	`#`
`53`	`55`	`# The use of the following functions, methods, classes and modules is shown`
Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,8 @@`
`77`	`77`
`78`	`78`	`# %%`
`79`	`79`	`#`
	`80`	`+# .. tags:: plot-type: errorbar, domain: statistics`
	`81`	`+#`
`80`	`82`	`# .. admonition:: References`
`81`	`83`	`#`
`82`	`84`	`# The use of the following functions, methods, classes and modules is shown`