In a violin plot, rows of data_frame are grouped together into a curved
mark to visualize their distribution.
Usage
px_violin(
data_frame = NULL,
x = NULL,
y = NULL,
color = NULL,
facet_row = NULL,
facet_col = NULL,
facet_col_wrap = 0,
facet_row_spacing = NULL,
facet_col_spacing = NULL,
hover_name = NULL,
hover_data = NULL,
custom_data = NULL,
animation_frame = NULL,
animation_group = NULL,
category_orders = NULL,
labels = NULL,
color_discrete_sequence = NULL,
color_discrete_map = NULL,
orientation = NULL,
violinmode = NULL,
log_x = FALSE,
log_y = FALSE,
range_x = NULL,
range_y = NULL,
points = NULL,
box = FALSE,
title = NULL,
subtitle = NULL,
template = NULL,
width = NULL,
height = NULL
)Arguments
- data_frame
A data.frame, data.table, list or matrix. Needed for column names to be used in the other arguments; if
NULL, a data frame is built from the vectors given in the other arguments.- x
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to position marks along the x axis in cartesian coordinates.- y
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to position marks along the y axis in cartesian coordinates.- color
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to assign color to marks.- facet_row
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to assign marks to facetted subplots in the vertical direction.- facet_col
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to assign marks to facetted subplots in the horizontal direction.- facet_col_wrap
Maximum number of facet columns. Wraps the column variable at this width, so that the column facets span multiple rows. Ignored if 0, and forced to 0 if
facet_rowor amarginalis set.- facet_row_spacing
Spacing between facet rows, in paper units. Default is 0.03 or 0.07 when facet_col_wrap is used.
- facet_col_spacing
Spacing between facet columns, in paper units Default is 0.02.
- hover_name
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector appear in bold in the hover tooltip.- hover_data
Extra data to show in the hover tooltip: column names (a character vector or a formula such as
~c(a, b)), or a named list with column names as names and valuesTRUE(default formatting),FALSE(hide the column, e.g. one shown by default), a d3-format string such as":.3f", a vector of data, or a list of a format string orTRUEand a vector of data.- custom_data
Column names (a character vector or a formula such as
~c(a, b)), or a list of column names, formulas and vectors. Values from these columns are added to the traces'customdata(e.g. for use in Shiny events) without appearing in the hover tooltip.- animation_frame
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to assign marks to animation frames.- animation_group
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to provide object-constancy across animation frames: rows with matchinganimation_groups will be treated as if they describe the same object in each frame.- category_orders
Named list mapping column names to the order of their values in axes, legends and facets, e.g.
list(day = c("Thur", "Fri", "Sat", "Sun")). By default values appear in the order first encountered, or in level order for factors.- labels
Named character vector or list mapping column names to the labels to use for axis titles, legend entries and hover text, e.g.
c(gdpPercap = "GDP per capita").- color_discrete_sequence
Character vector of colors, e.g.
px_colors$qualitative$Set1. Values ofcolorare assigned colors in order (cycling), unless set incolor_discrete_map. Defaults to the template'scolorway.- color_discrete_map
Named character vector or list mapping values of
colorto colors, overridingcolor_discrete_sequence. If the values ofcolorare colors,px_identity()(or"identity") uses them directly.- orientation
(default
"v"ifxandyare provided and both continuous or both categorical, otherwise"v"("h") ifx(y) is categorical andy(x) is continuous, otherwise"v"("h") if onlyx(y) is provided)- violinmode
One of
"group"or"overlay"In"overlay"mode, violins are on drawn top of one another. In"group"mode, violins are placed beside each other.- log_x
If
TRUE, the x-axis is log-scaled in cartesian coordinates.- log_y
If
TRUE, the y-axis is log-scaled in cartesian coordinates.- range_x
If provided, overrides auto-scaling on the x-axis in cartesian coordinates.
- range_y
If provided, overrides auto-scaling on the y-axis in cartesian coordinates.
- points
One of
"outliers","suspectedoutliers","all", orFALSE. If"outliers", only the sample points lying outside the whiskers are shown. If"suspectedoutliers", all outlier points are shown and those less than 4Q1-3Q3 or greater than 4Q3-3Q1 are highlighted with the marker's"outliercolor". If"outliers", only the sample points lying outside the whiskers are shown. If"all", all sample points are shown. IfFALSE, no sample points are shown and the whiskers extend to the full range of the sample.- box
If
TRUE, boxes are drawn inside the violins.- title
The figure title.
- subtitle
The figure subtitle.
- template
A template name (see
template_names()) or a template list. Defaults todefault_template().- width
The figure width in pixels.
- height
The figure height in pixels.
Value
A go_figure().
See also
Other plotly express:
px_area(),
px_bar(),
px_bar_polar(),
px_box(),
px_choropleth(),
px_choropleth_map(),
px_density_contour(),
px_density_heatmap(),
px_density_map(),
px_ecdf(),
px_funnel(),
px_funnel_area(),
px_histogram(),
px_icicle(),
px_imshow(),
px_line(),
px_line_3d(),
px_line_geo(),
px_line_map(),
px_line_polar(),
px_line_ternary(),
px_parallel_categories(),
px_parallel_coordinates(),
px_pie(),
px_scatter(),
px_scatter_3d(),
px_scatter_geo(),
px_scatter_map(),
px_scatter_matrix(),
px_scatter_polar(),
px_scatter_ternary(),
px_strip(),
px_sunburst(),
px_timeline(),
px_treemap()
Examples
px_data_tips() |> px_violin(y = ~total_bill, x = ~day, color = ~smoker, box = TRUE)