@@ -8206,43 +8206,41 @@ def violinplot(self, dataset, positions=None, vert=True, widths=0.5,
8206
8206
The input data.
8207
8207
8208
8208
positions : array-like, default: [1, 2, ..., n]
8209
- The positions of the violins. The ticks and limits are
8210
- automatically set to match the positions .
8209
+ The positions of the violins; i.e. coordinates on the x-axis for
8210
+ vertical violins (or y-axis for horizontal violins) .
8211
8211
8212
8212
vert : bool, default: True.
8213
8213
If true, creates a vertical violin plot.
8214
8214
Otherwise, creates a horizontal violin plot.
8215
8215
8216
- widths : array-like, default: 0.5
8217
- Either a scalar or a vector that sets the maximal width of
8218
- each violin. The default is 0.5, which uses about half of the
8219
- available horizontal space .
8216
+ widths : float or array-like, default: 0.5
8217
+ The maximum width of each violin in units of the *positions* axis.
8218
+ The default is 0.5, which is half the available space when using default
8219
+ *positions* .
8220
8220
8221
8221
showmeans : bool, default: False
8222
- If `True`, will toggle rendering of the means .
8222
+ Whether to show the mean with a line .
8223
8223
8224
8224
showextrema : bool, default: True
8225
- If `True`, will toggle rendering of the extrema .
8225
+ Whether to show extrema with a line .
8226
8226
8227
8227
showmedians : bool, default: False
8228
- If `True`, will toggle rendering of the medians .
8228
+ Whether to show the median with a line .
8229
8229
8230
8230
quantiles : array-like, default: None
8231
8231
If not None, set a list of floats in interval [0, 1] for each violin,
8232
8232
which stands for the quantiles that will be rendered for that
8233
8233
violin.
8234
8234
8235
8235
points : int, default: 100
8236
- Defines the number of points to evaluate each of the
8237
- gaussian kernel density estimations at.
8236
+ The number of points to evaluate each of the gaussian kernel density
8237
+ estimations at.
8238
8238
8239
- bw_method : str, scalar or callable, optional
8240
- The method used to calculate the estimator bandwidth. This can be
8241
- 'scott', 'silverman', a scalar constant or a callable. If a
8242
- scalar, this will be used directly as `kde.factor`. If a
8239
+ bw_method : {'scott', 'silverman'} or float or callable, default: 'scott'
8240
+ The method used to calculate the estimator bandwidth. If a
8241
+ float, this will be used directly as `kde.factor`. If a
8243
8242
callable, it should take a `matplotlib.mlab.GaussianKDE` instance as
8244
- its only parameter and return a scalar. If None (default), 'scott'
8245
- is used.
8243
+ its only parameter and return a float.
8246
8244
8247
8245
data : indexable object, optional
8248
8246
DATA_PARAMETER_PLACEHOLDER
@@ -8329,26 +8327,26 @@ def violin(self, vpstats, positions=None, vert=True, widths=0.5,
8329
8327
for this violin's dataset.
8330
8328
8331
8329
positions : array-like, default: [1, 2, ..., n]
8332
- The positions of the violins. The ticks and limits are
8333
- automatically set to match the positions .
8330
+ The positions of the violins; i.e. coordinates on the x-axis for
8331
+ vertical violins (or y-axis for horizontal violins) .
8334
8332
8335
8333
vert : bool, default: True.
8336
8334
If true, plots the violins vertically.
8337
8335
Otherwise, plots the violins horizontally.
8338
8336
8339
- widths : array-like, default: 0.5
8340
- Either a scalar or a vector that sets the maximal width of
8341
- each violin. The default is 0.5, which uses about half of the
8342
- available horizontal space .
8337
+ widths : float or array-like, default: 0.5
8338
+ The maximum width of each violin in units of the *positions* axis.
8339
+ The default is 0.5, which is half available space when using default
8340
+ *positions* .
8343
8341
8344
8342
showmeans : bool, default: False
8345
- If true, will toggle rendering of the means .
8343
+ Whether to show the mean with a line .
8346
8344
8347
8345
showextrema : bool, default: True
8348
- If true, will toggle rendering of the extrema .
8346
+ Whether to show extrema with a line .
8349
8347
8350
8348
showmedians : bool, default: False
8351
- If true, will toggle rendering of the medians .
8349
+ Whether to show the median with a line .
8352
8350
8353
8351
Returns
8354
8352
-------
0 commit comments