Merge pull request matplotlib#19231 from ianhi/demos

QuLogic · web-flow · commit a5ea869114fd · 2021-01-04T20:17:35.000-05:00
Add reference section to all statistics examples
diff --git a/.flake8 b/.flake8
@@ -288,3 +288,4 @@ per-file-ignores =
     examples/userdemo/custom_boxstyle01.py: E402
     examples/userdemo/pgf_preamble_sgskip.py: E402
     examples/widgets/*.py: E402
+    examples/statistics/*.py: E402
diff --git a/examples/statistics/boxplot.py b/examples/statistics/boxplot.py
@@ -95,3 +95,16 @@
 fig.suptitle("I never said they'd be pretty")
 fig.subplots_adjust(hspace=0.4)
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.boxplot
+matplotlib.pyplot.boxplot
diff --git a/examples/statistics/boxplot_color.py b/examples/statistics/boxplot_color.py
@@ -51,3 +51,16 @@
     ax.set_ylabel('Observed values')
 
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.boxplot
+matplotlib.pyplot.boxplot
diff --git a/examples/statistics/boxplot_demo.py b/examples/statistics/boxplot_demo.py
@@ -230,3 +230,17 @@ def fake_bootstrapper(n):
 plt.setp(bp['whiskers'], color='k', linestyle='-')
 plt.setp(bp['fliers'], markersize=3.0)
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.boxplot
+matplotlib.pyplot.boxplot
+matplotlib.axes.Axes.set
diff --git a/examples/statistics/boxplot_vs_violin.py b/examples/statistics/boxplot_vs_violin.py
@@ -53,3 +53,18 @@
 plt.setp(axs, xticks=[y + 1 for y in range(len(all_data))],
          xticklabels=['x1', 'x2', 'x3', 'x4'])
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.boxplot
+matplotlib.pyplot.boxplot
+matplotlib.axes.Axes.violinplot
+matplotlib.pyplot.violinplot
diff --git a/examples/statistics/bxp.py b/examples/statistics/bxp.py
@@ -102,3 +102,16 @@
 fig.suptitle("I never said they'd be pretty")
 fig.subplots_adjust(hspace=0.4)
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.bxp
+matplotlib.cbook.boxplot_stats
diff --git a/examples/statistics/confidence_ellipse.py b/examples/statistics/confidence_ellipse.py
@@ -214,3 +214,16 @@ def get_correlated_dataset(n, dependency, mu, scale):
 
 fig.subplots_adjust(hspace=0.25)
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.transforms.Affine2D
+matplotlib.patches.Ellipse
diff --git a/examples/statistics/customized_violin.py b/examples/statistics/customized_violin.py
@@ -74,3 +74,18 @@ def set_axis_style(ax, labels):
 
 plt.subplots_adjust(bottom=0.15, wspace=0.05)
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.violinplot
+matplotlib.pyplot.violinplot
+matplotlib.axes.Axes.vlines
+matplotlib.pyplot.vlines
diff --git a/examples/statistics/errorbar.py b/examples/statistics/errorbar.py
@@ -18,3 +18,16 @@
 fig, ax = plt.subplots()
 ax.errorbar(x, y, xerr=0.2, yerr=0.4)
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.errorbar
+matplotlib.pyplot.errorbar
diff --git a/examples/statistics/errorbar_features.py b/examples/statistics/errorbar_features.py
@@ -45,3 +45,16 @@
 ax1.set_title('variable, asymmetric error')
 ax1.set_yscale('log')
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.errorbar
+matplotlib.pyplot.errorbar
diff --git a/examples/statistics/errorbar_limits.py b/examples/statistics/errorbar_limits.py
@@ -74,3 +74,16 @@
 ax.set_xlim((0, 5.5))
 ax.set_title('Errorbar upper and lower limits')
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.errorbar
+matplotlib.pyplot.errorbar
diff --git a/examples/statistics/errorbars_and_boxes.py b/examples/statistics/errorbars_and_boxes.py
@@ -67,3 +67,18 @@ def make_error_boxes(ax, xdata, ydata, xerror, yerror, facecolor='r',
 _ = make_error_boxes(ax, x, y, xerr, yerr)
 
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.errorbar
+matplotlib.pyplot.errorbar
+matplotlib.axes.Axes.add_collection
+matplotlib.collections.PatchCollection
diff --git a/examples/statistics/hexbin_demo.py b/examples/statistics/hexbin_demo.py
@@ -42,3 +42,16 @@
 cb.set_label('log10(N)')
 
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.hexbin
+matplotlib.pyplot.hexbin
diff --git a/examples/statistics/hist.py b/examples/statistics/hist.py
@@ -100,3 +100,18 @@
 axs[2].hist2d(x, y, bins=(80, 10), norm=colors.LogNorm())
 
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.hist
+matplotlib.pyplot.hist
+matplotlib.pyplot.hist2d
+matplotlib.ticker.PercentFormatter
diff --git a/examples/statistics/histogram_cumulative.py b/examples/statistics/histogram_cumulative.py
@@ -70,3 +70,16 @@
 ax.set_ylabel('Likelihood of occurrence')
 
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.hist
+matplotlib.pyplot.hist
diff --git a/examples/statistics/histogram_features.py b/examples/statistics/histogram_features.py
@@ -9,8 +9,6 @@
 * The *density* parameter, which normalizes bin heights so that the integral of
   the histogram is 1. The resulting histogram is an approximation of the
   probability density function.
-* Setting the face color of the bars.
-* Setting the opacity (alpha value).
 
 Selecting different bin counts and sizes can significantly affect the shape
 of a histogram. The Astropy docs have a great section_ on how to select these
@@ -19,7 +17,6 @@
 .. _section: http://docs.astropy.org/en/stable/visualization/histogram.html
 """
 
-import matplotlib
 import numpy as np
 import matplotlib.pyplot as plt
 
@@ -58,7 +55,9 @@
 #
 # The use of the following functions and methods is shown in this example:
 
+import matplotlib
 matplotlib.axes.Axes.hist
+matplotlib.pyplot.hist
 matplotlib.axes.Axes.set_title
 matplotlib.axes.Axes.set_xlabel
 matplotlib.axes.Axes.set_ylabel
diff --git a/examples/statistics/histogram_histtypes.py b/examples/statistics/histogram_histtypes.py
@@ -48,3 +48,16 @@
 
 fig.tight_layout()
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.hist
+matplotlib.pyplot.hist
diff --git a/examples/statistics/histogram_multihist.py b/examples/statistics/histogram_multihist.py
@@ -44,3 +44,16 @@
 
 fig.tight_layout()
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.hist
+matplotlib.pyplot.hist
diff --git a/examples/statistics/multiple_histograms_side_by_side.py b/examples/statistics/multiple_histograms_side_by_side.py
@@ -61,3 +61,16 @@
 ax.set_xlabel("Data sets")
 
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.barh
+matplotlib.pyplot.barh
diff --git a/examples/statistics/time_series_histogram.py b/examples/statistics/time_series_histogram.py
@@ -94,3 +94,17 @@
 toc = time.time()
 print(f"{toc-tic:.3f} sec. elapsed")
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.pcolormesh
+matplotlib.pyplot.pcolormesh
+matplotlib.figure.Figure.colorbar
diff --git a/examples/statistics/violinplot.py b/examples/statistics/violinplot.py
@@ -85,3 +85,16 @@
 fig.suptitle("Violin Plotting Examples")
 fig.subplots_adjust(hspace=0.4)
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.violinplot
+matplotlib.pyplot.violinplot
